Format for the readme.txt file
There are only a couple more requirements for you to fulfill before you can submit your plugin to the WordPress repository. One of those requirements is that each plugin must be accompanied by a readme.txt
file, and several of the other requirements can piggyback on its merits once you have written this file. We included information about writing good documentation in the previous chapter—this section has only to do with using the correct format for that documentation.
The readme.txt
file uses a standardized format to describe a plugin's functionality, installation procedures, and a usage manual. Its contents are automatically parsed by the WordPress plugin repository to display an information page for each plugin—you've ...
Get WordPress 3 Plugin Development Essentials now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.