Subscribe Via RSS170 Plugin Release and Promotion
Writing Your Plugin Readme.txt File
Writing a readme.txt file is not hard if you invest in a little planning and thought beforehand. Just place yourself in the users place, how would you view your plugin for the first time.
- What information would you need to get optimal usage from your plugin?
- What special instructions or code snippets are required?
- What potential problems could arise?
- How does the user interface enhance the users experience?
- What makes your plugin stand out?
- What useful information can I tell the user now to stop them asking later?
All readme.txt files are split into sections and the whole file is written using Markdown syntax. The basic structure of a plugin’s readme.txt file intended for the WP.org repository is as follows:
Plugin HEADER Section Plugin BODY Sections == Description == == Installation == == Frequently Asked Questions == == Screenshots == == Changelog == == Upgrade Notice == == Additional Info (Optional) ==
Important note: Affiliate links and spam links are not allowed in plugin readme.txt files. Spam will get you banned immediately. Affiliate links may get your plugin removed. Play safe, don’t include affiliate or spam links.
