Merge branch 'trunk' into add-module-loader

Author: ryanwelcher

README.md

@@ -15,77 +15,4 @@ It will give you all of the tools you needs to get up and running quickly.
 
 ## How do I use it?
 
-### Creating a new repository from this template
-
-Click the `Use this template` button to create a new repository in your own GitHub account from this template.
-
-### Setting up the repository secrets
-
-Go to the Secrets and Variables->Actions sections under the Settings menu of the new repository.
-Under the Repository secrets sections, create new the secrets outlined in the table below.
-
-### Secrets
-
-| Secret                | Description                                 |
-| --------------------- | ------------------------------------------- |
-| PROD_SFTP_USER        | The username for the Production SFTP server |
-| PROD_SFTP_PASSWORD    | The password for the Production SFTP server |
-| STAGING_SFTP_USER     | The username for the Staging SFTP server    |
-| STAGING_SFTP_PASSWORD | The password for the Staging SFTP server    |
-
-### Adding some branch protection rules
-
-1. Navigate to Settings > Branches.
-2. Click on **Add classic branch protection rule**
-3. Enter `trunk` into the Branch name pattern field.
-4. Check **Require a pull request before merging**.
-5. Check **Require approvals**. You can leave the number of required approval set at 1.
-6. Click on **Create**.
-7. Check Require status checks to pass before merging
-8. In the search box, searching for “Linting” and add each status check that appears. There should be 3 in total.
-
-## Adding collaborators
-
-In Settings->Collaborators and teams section of the new repository, add the Newspack team as a collaborators with write access.
-You may need to add them individually and you can get their usernames from the Newspack team.
-
-### Checking out the repo locally
-
-Checkout the repo locally and run `npm run setup` to install everything.
-
-```bash
-git clone <your-repo-url>
-
-cd <your-repo-name>
-
-npm run setup
-```
-
-### Create the staging branch
-
-In it doesn't already exist, create and `staging` branch and push it to the remote repository.
-
-```bash
-git checkout -b staging
-
-git push origin staging
-```
-
-### Search and replace to add your name to the plugin
-
-Do a search and replace in all files for `PublisherName`, `publisher-name` and `Publisher Name` and replace them with the name of your site in the same format. Example: `MySite`, `my-site` and `My Site`.
-
-### Optional: create modules
-
-We strongly suggest that you use the provided Modules framework to organize your code. Overtime, your custom plugin can grow and house several different features and tweaks, and it's a good idea to keep things organized so anyone can easily navigate through the code.
-
-Here are some benefits of developing each feature or small tweak as an independent module:
-
-* Code organization: easy to see what you have and to find what you're looking for
-* Documentation: By using modules, you are documenting what you have and avoid getting to a state that nobody even remembers everything that the plugin does
-* Enable/disable modules: The ability to enable and disable modules per site.
-
-To create a module, add a new folder under the `modules` folder and add a `module.php` file to it. Optionally, but recommended, add a `info.json` file with a name and a description for the module.
-
-See the provided `sample` module and use it as a starting point.
-
+Please refer to [How to set up the Newspack Starter Template for custom plugins](https://help.newspack.com/how-to-set-up-the-newspack-starter-template-for-custom-plugins/) on help.newspack.com for up-to-date installation and setup instructions.