Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aschweigert authored Oct 24, 2023
1 parent 73afab5 commit 3f568e0
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,23 @@ Fortunately, there's a [plugin updater library](https://github.com/YahnisElsts/p

For the time being this plugin just checks for the most commonly-used Newspack plugins (there are a [handful of others](https://github.com/orgs/Automattic/repositories?q=newspack) but those seemed less essential to keep tabs on):

* Newspack Plugin
* Newspack Ads
* Newspack Blocks
* Newspack Popups (aka Campaigns)
* Newspack Listings
* Newspack Sponsors
* Newspack Media Partners
* Newspack RSS Enhancements
* Newspack Supporters
* [Newspack Plugin](https://github.com/automattic/newspack-plugin)
* [Newspack Ads](https://github.com/automattic/newspack-ads)
* [Newspack Blocks](https://github.com/automattic/newspack-blocks)
* [Newspack Popups (aka Campaigns)](https://github.com/automattic/newspack-popups)
* [Newspack Listings](https://github.com/automattic/newspack-listings)
* [Newspack Sponsors](https://github.com/automattic/newspack-sponsors)
* [Newspack Media Partners](https://github.com/automattic/newspack-media-partners)
* [Newspack RSS Enhancements](https://github.com/automattic/newspack-rss-enhancements)
* [Newspack Supporters](https://github.com/automattic/newspack-supporters)

## Some Notes

The plugin assumes you have the plugin(s) in folders named using their respective slugs (e.g. wp-content/plugins/newspack-plugin/). If you initially downloaded the plugin(s) from GitHub they may have had the branch name or release tag appended (e.g. wp-content/plugins/newspack-plugin-master/). You'll need to rename the folder if this is the case.

Newspack uses Composer to build the releases for their plugins so a common gotcha is trying to download the Main (or Release) branch directly. Fortunately, this plugin updater library has the option to grab the zip file of the latest tagged release, so that's what it's using to perform the update (which should work just fine).

I hope this is helpful! Let me know if you have any questions or run into any issues.
## Questions? Comments?

I hope this is helpful. Let me know if you have any questions or run into any issues. The best thing is simply to open a GitHub issue on this repository and I'll get back to you as soon as I can!

0 comments on commit 3f568e0

Please sign in to comment.