After writing some WordPress Plugins recently, I found that it takes a lot of effort to generate the Readme file for each of them.
For the uninitiated, readme file is a text file which has meta information about the Plugin and is usually bundled with the Plugin. Readme files for WordPress Plugins are very important, especially if you are planning to upload them to the official repository. WordPress follows a standard for the readme file so that the official repository can parse the meta information present in the file and render it like shown in the below screenshot.
The official Plugin repository has a sample readme file and also a validator. The readme file should have some tags and the text should be specified in the markdown format.
I was looking for ways to automate the process of generating these readme files and didn’t find a solution. So I created my own 🙂
You can find the WordPress Plugin readme file generator in my projects page and you can use it to generate the readme file for your WordPress Plugins too. 🙂
Try it out guys and let me know if you want any other feature to be added to it.
Like it, Sudar. Keep up the good work!
@eduardo,
Nice to know that you like this tool. Thanks 🙂