Creating a README file for your plugin
If you look at any plugins on the official WordPress repository, you will see that their page contains a lot of information. This includes a description of the extension, a list of frequently asked questions, and installation notes. As you may have noticed from the work that we have done so far, this data does not reside in the main plugin's code file. Instead, the official WordPress repository looks for this information in a specially formatted
readme.txt file that needs to be included with the plugin.
You should have already followed the Updating page title to include custom post data using plugin filters recipe in Chapter 4, The Power of Custom Post Types, to have a starting point for this recipe. Alternatively, you can get the resulting code (
ch4/ch4-book-reviews/ch4-book-reviews-v12.php) for that recipe from the book's GitHub page.
How to do it...
Follow these steps to create a
readme.txt file for the Book...