WordPress Plugin Readme File Generator

You can use the form below to generate the readme file for your WordPress Plugins. Fill in the details and then click the Generate Button.

If you have any comments or feedbacks kindly leave a comment below.

PS: You can also find out how I created it.

Oops!, We Have a Problem.

Required fields

"Contributors" is a comma separated list of wp.org/wp-plugins.org usernames

"Tags" is a comma separated list of tags that apply to the plugin

"Requires at least" is the lowest version that the plugin will work on

"Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on higher versions... this is just the highest one you've verified.

Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for stable. If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where you put the stable version, in order to eliminate any doubt.

Description of the Plugin in less than 2 - 3 sentences. Maximum 150 characters, rest will be truncated.

Optional fields

Detailed description of the Plugin. If it is not specified then the short description is used

If you accept donations then specify the link to your donations page

Describe how to install the Plugin and get it working

Frequently Asked Questions (if any)

Change Log (if any)

Description for first screenshot. The file should be named screenshot-1.(png|jpg|jpeg|gif) and should be placed in the directory of the stable readme.txt. The file extension can be any one of these png, jpg, jpeg, gif

Description for the second screenshot. The file should be named screenshot-1.(png|jpg|jpeg|gif) and should be placed in the directory of the stable readme.txt. The file extension can be any one of these png, jpg, jpeg, gif

If it is a Youtube or Vimeo video, then enter the video url. If it is a wordpress.tv video, then enter the video id.

You may provide arbitrary information here. This may be of use for extremely complicated plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or "installation."

Add a small "generated with WP-Readme link in the other notes section.

This will add a small "generated with WP-Readme" link in the other notes secion.

9 Comments so far

Trackback URI | Follow up comments through RSS Feed | Post a comment

2 Tweetbacks so far

48 Trackbacks/Pingbacks so far

Leave a Reply