Skip to content

Commit a964dd8

Browse files
authored
feat: test release workflow with README changes (#26)
1 parent 824a75a commit a964dd8

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# newspack-sponsors
22

3+
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![newspack-plugin](https://circleci.com/gh/Automattic/newspack-plugin/tree/master.svg?style=shield)](https://circleci.com/gh/Automattic/newspack-plugin)
4+
35
Create sponsors, edit sponsor info, and associate sponsors with posts, categories and tags. Allows special visual treatment for sponsored content.
46

57
## Usage
@@ -20,7 +22,7 @@ To use in a theme, check for the existence of the helper function first. Then ca
2022

2123
```
2224
if ( function_exists( '\Newspack_Sponsors\get_all_sponsors' ) ) {
23-
$sponsors = \Newspack_Sponsors\get_all_sponsors( get_the_ID(), 'native' );
25+
$sponsors = \Newspack_Sponsors\get_all_sponsors( get_the_ID(), 'native', [ 'maxwidth' => 130, 'maxheight' => 45 ] );
2426
var_dump( $sponsors );
2527
}
2628
```
@@ -37,6 +39,6 @@ Both helpers will return an array containing all sponsors that are associated wi
3739
- `sponsor_blurb` - Content which can be displayed with any sponsored post. This is the `content` of the sponsor.
3840
- `sponsor_url` - A URL to link to when displaying the Sponsor Name on the front-end.
3941
- `sponsor_byline` - The copy shown in lieu of a byline on sponsored posts. This is combined with the `sponsor_name` to form a full byline. (Default: “Sponsored by” or “Paid for by”)
40-
- `sponsor_logo` - HTML for a medium-sized image to be displayed with any sponsored post. This is the `thumbnail` of the sponsor.
42+
- `sponsor_logo` - Object containing properties for a medium-sized image to be displayed with any sponsored post. This is the `thumbnail` of the sponsor. Contains `src`, `img_width` and `img_height` properties.
4143
- `sponsor_flag` - The label that appears in lieu of a category tag for sponsored content. This can be set site-wide and overridden per sponsor.
4244
- `sponsor_disclaimer` - The disclaimer that explains sponsored content. This can be set site-wide and overridden per sponsor.

0 commit comments

Comments
 (0)