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

*Plugin Name

*Contributors

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

*Tags

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

*Requires at least

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

*Tested up to

"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

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.

*Short Description

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

Optional fields

Long Description

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

Donate Link

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

Installation Instruction

Describe how to install the Plugin and get it working

Frequently Asked Questions

Frequently Asked Questions (if any)

Change Log

Change Log (if any)

First Screenshot Description

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

Second Screenshot Description

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

Video

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.

Arbitrary section

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."

Link love 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.

Kaitora says:

Mar 10, 2010 at 3:11 am

This is a wonderful resource, I’ve just made my first plugin, and this has helped me make my first readme. Thanks

david says:

Jun 27, 2010 at 6:37 pm

Very very useful helped a lot in creating my first plugin.
The editor boxes didnt work at first (the text all went off the screen to the left as I typed – using minefield 3.7 but worked fine in chrome)

thanks again

Emiliano Jankowski says:

Aug 18, 2011 at 9:58 pm

Cool form!! Very useful!

Thanks!

bitacre says:

Jan 31, 2012 at 1:59 pm

If any of your readers find your generator too long or confusing, I built a simpler readme.txt generator designed for use with new plugins that automates more of the process. I’ll link to this generator from mine for people looking for more verbose options.