A complete template
=== Amitry Internal Links ===
Contributors: yourwporgusername
Tags: internal links, seo, links, editor
Requires at least: 6.5
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.2.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Suggests internal links while you write, ranked by relevance. Nothing is inserted automatically.
== Description ==
What the plugin does and how to use it.
== Installation ==
1. Install from Plugins → Add New, or upload the folder to /wp-content/plugins/.
2. Activate it and open Settings → Internal Links.
== Frequently Asked Questions ==
= Does it change existing posts? =
No. Links are only added when you click a suggestion.
== Screenshots ==
1. The settings page, where you choose which post types get suggestions.
2. Suggestions in the editor sidebar, ranked by relevance.
== Changelog ==
= 1.2.0 =
* New: relevance score for every suggestion.The header fields
| Field | What it does |
|---|---|
=== Name === | The name shown on wordpress.org. Falls back to the name in your main plugin file. |
Contributors | wordpress.org usernames, comma-separated and case-sensitive. Anything else shows without a profile link. |
Tags | 1 to 5 terms. Don't use competitors' plugin names. Tags no other plugin uses aren't shown. |
Requires at least | Lowest WordPress version. Since WordPress 5.8 this is read from your main plugin file, so keep both the same. |
Tested up to | The latest major WordPress version you tested, numbers only: 7.1, not WP 7.1. |
Requires PHP | Lowest PHP version, numbers only. Also read from the main plugin file. |
Stable tag | Your plugin's version, matching a folder in tags/. See below. |
License | GPLv2 or later, or a compatible licence. Add License URI for anything less common. |
The short description: 150 characters
The line right after the header is the short description. It appears under your plugin's name and is cut off after 150 characters. No formatting is allowed in it. Say what the plugin does, not what it is called: in our benchmark, a short description under 40 characters usually just repeats the name.
Stable tag decides which readme is shown
wordpress.org reads Stable tag from the readme in trunk, then shows the readme from the matching folder, for example tags/1.2.0/. After that, editing the readme in trunk changes nothing on your page; you have to edit the one in the tag as well. The tagged readme also needs the correct Stable tag, otherwise updates can fail.
Stable tag: trunk is no longer allowed for new plugins.
Keep it short
A readme over 10 KB can cause errors. The handbook recommends keeping only the current release in the changelog and moving older entries to a separate changelog.txt.
A YouTube or Vimeo link on a line of its own is embedded as a video.
Check it before you commit
The official readme validator shows missing fields and formatting errors before they reach your page.