What is a WordPress Plugin Readme.txt?
A WordPress Plugin Readme.txt is a metadata and documentation file formatted in custom markdown rules that is parsed directly by the official WordPress.org plugin repository. The directory parser reads this file to generate your plugin’s homepage design, screenshot grids, installation instructions, changelog timelines, and stable releases tags.
The Role of the Stable Tag in Deployment
Inside the plugin readme.txt file header, the Stable tag line tells the repository release systems which folder inside your subversion (SVN) tags directory contains the active, validated code version. If you set Stable tag: 1.0.0, WordPress will download the code packaged inside the SVN folder `/tags/1.0.0/` rather than the active master files inside `/trunk/`.
Standard Sections Required in Plugin Readme Files
- Description: Details the features, screenshots, and operational instructions of the plugin.
- Installation: Step-by-step instructions telling site managers how to activate and setup the plugin.
- Changelog: An audit list tracking feature additions and bug resolutions across releases (important for security compliance audits).
Frequently Asked Questions
Q: What happens if my readme has errors?
WordPress.org provides a validation engine. Running your readme through a generator ensures you use correct markdown markers (like triple equals === for titles) to prevent layout breakages on your plugin directory homepage.
Q: Can I include screenshots in my readme?
Yes. You list them under the == Screenshots == header, and save matching graphic files named screenshot-1.png in your plugin’s SVN `/assets/` directory.