From 890e581d255b400ee9afb9adc5708c0271d9a8fc Mon Sep 17 00:00:00 2001 From: Dave Moran Date: Wed, 2 Oct 2019 12:19:08 -0400 Subject: [PATCH 1/4] Add links to new wordpress readme standards --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 06cea1d4..5c5cf608 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,20 @@ From the users' perspective, it works just like with plugins and themes hosted o **Table of Contents** -- [Getting Started](#getting-started) - - [Self-hosted Plugins and Themes](#self-hosted-plugins-and-themes) - - [How to Release an Update](#how-to-release-an-update) - - [Notes](#notes) - - [GitHub Integration](#github-integration) - - [How to Release an Update](#how-to-release-an-update-1) - - [Notes](#notes-1) - - [BitBucket Integration](#bitbucket-integration) - - [How to Release an Update](#how-to-release-an-update-2) - - [GitLab Integration](#gitlab-integration) - - [How to Release an Update](#how-to-release-an-update-3) -- [License Management](#license-management) -- [Resources](#resources) +- [Plugin Update Checker](#plugin-update-checker) + - [Getting Started](#getting-started) + - [Self-hosted Plugins and Themes](#self-hosted-plugins-and-themes) + - [How to Release an Update](#how-to-release-an-update) + - [Notes](#notes) + - [GitHub Integration](#github-integration) + - [How to Release an Update](#how-to-release-an-update-1) + - [Notes](#notes-1) + - [BitBucket Integration](#bitbucket-integration) + - [How to Release an Update](#how-to-release-an-update-2) + - [GitLab Integration](#gitlab-integration) + - [How to Release an Update](#how-to-release-an-update-3) + - [License Management](#license-management) + - [Resources](#resources) @@ -106,7 +107,7 @@ By default, the library will check the specified URL for changes every 12 hours. //Optional: Set the branch that contains the stable release. $myUpdateChecker->setBranch('stable-branch-name'); ``` -3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update @@ -192,7 +193,7 @@ The library will pull update details from the following parts of a release/tag/b //Optional: Set the branch that contains the stable release. $myUpdateChecker->setBranch('stable-branch-name'); ``` -3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. For plugins, the contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. For plugins, the contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update @@ -200,7 +201,7 @@ BitBucket doesn't have an equivalent to GitHub's releases, so the process is sli - **`Stable tag` header** - This is the recommended approach if you're using tags to mark each version. Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. Set the "stable tag" header to the tag that represents the latest release. Example: + This is the recommended approach if you're using tags to mark each version. Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. Set the "stable tag" header to the tag that represents the latest release. Example: ```text Stable tag: v1.2.3 ``` @@ -261,7 +262,7 @@ BitBucket doesn't have an equivalent to GitHub's releases, so the process is sli ``` -3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update From 3387ed05852bb1f0a036f23b8eb740c901926837 Mon Sep 17 00:00:00 2001 From: Dave Moran Date: Wed, 2 Oct 2019 12:23:28 -0400 Subject: [PATCH 2/4] Revert doctoc section --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5c5cf608..47b737f2 100644 --- a/README.md +++ b/README.md @@ -9,20 +9,19 @@ From the users' perspective, it works just like with plugins and themes hosted o **Table of Contents** -- [Plugin Update Checker](#plugin-update-checker) - - [Getting Started](#getting-started) - - [Self-hosted Plugins and Themes](#self-hosted-plugins-and-themes) - - [How to Release an Update](#how-to-release-an-update) - - [Notes](#notes) - - [GitHub Integration](#github-integration) - - [How to Release an Update](#how-to-release-an-update-1) - - [Notes](#notes-1) - - [BitBucket Integration](#bitbucket-integration) - - [How to Release an Update](#how-to-release-an-update-2) - - [GitLab Integration](#gitlab-integration) - - [How to Release an Update](#how-to-release-an-update-3) - - [License Management](#license-management) - - [Resources](#resources) +- [Getting Started](#getting-started) + - [Self-hosted Plugins and Themes](#self-hosted-plugins-and-themes) + - [How to Release an Update](#how-to-release-an-update) + - [Notes](#notes) + - [GitHub Integration](#github-integration) + - [How to Release an Update](#how-to-release-an-update-1) + - [Notes](#notes-1) + - [BitBucket Integration](#bitbucket-integration) + - [How to Release an Update](#how-to-release-an-update-2) + - [GitLab Integration](#gitlab-integration) + - [How to Release an Update](#how-to-release-an-update-3) +- [License Management](#license-management) +- [Resources](#resources) From 5ec9acf7ed839943278b0dc73bbbbed1e3658647 Mon Sep 17 00:00:00 2001 From: Dave Moran Date: Wed, 2 Oct 2019 12:26:26 -0400 Subject: [PATCH 3/4] Update link to proper location --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 47b737f2..c1a97199 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ By default, the library will check the specified URL for changes every 12 hours. //Optional: Set the branch that contains the stable release. $myUpdateChecker->setBranch('stable-branch-name'); ``` -3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update @@ -192,7 +192,7 @@ The library will pull update details from the following parts of a release/tag/b //Optional: Set the branch that contains the stable release. $myUpdateChecker->setBranch('stable-branch-name'); ``` -3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. For plugins, the contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. For plugins, the contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update @@ -200,7 +200,7 @@ BitBucket doesn't have an equivalent to GitHub's releases, so the process is sli - **`Stable tag` header** - This is the recommended approach if you're using tags to mark each version. Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. Set the "stable tag" header to the tag that represents the latest release. Example: + This is the recommended approach if you're using tags to mark each version. Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. Set the "stable tag" header to the tag that represents the latest release. Example: ```text Stable tag: v1.2.3 ``` @@ -261,7 +261,7 @@ BitBucket doesn't have an equivalent to GitHub's releases, so the process is sli ``` -3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update From 18331fae68f28d6756ebf5cdbf93b4980be5972f Mon Sep 17 00:00:00 2001 From: Dave Moran Date: Wed, 2 Oct 2019 12:34:25 -0400 Subject: [PATCH 4/4] Final link to readme.txt --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c1a97199..697bbb3f 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ By default, the library will check the specified URL for changes every 12 hours. //Optional: Set the branch that contains the stable release. $myUpdateChecker->setBranch('stable-branch-name'); ``` -3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/readme.txt) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update @@ -192,7 +192,7 @@ The library will pull update details from the following parts of a release/tag/b //Optional: Set the branch that contains the stable release. $myUpdateChecker->setBranch('stable-branch-name'); ``` -3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. For plugins, the contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/readme.txt) to your repository. For plugins, the contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update @@ -200,7 +200,7 @@ BitBucket doesn't have an equivalent to GitHub's releases, so the process is sli - **`Stable tag` header** - This is the recommended approach if you're using tags to mark each version. Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. Set the "stable tag" header to the tag that represents the latest release. Example: + This is the recommended approach if you're using tags to mark each version. Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/readme.txt) to your repository. Set the "stable tag" header to the tag that represents the latest release. Example: ```text Stable tag: v1.2.3 ``` @@ -261,7 +261,7 @@ BitBucket doesn't have an equivalent to GitHub's releases, so the process is sli ``` -3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/developers/#readme) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. +3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/readme.txt) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link. #### How to Release an Update