Readme.txt format for WordPress Plugins

April 16th, 2005

To make sure that the Readme file format does not adversely affect any developers and to formalize the format for use in the future to catalog and categorize WordPress plugins, I have started a Readme.txt Format for WordPress Plugins wiki page.

Understand that this is the format to be used for every readme.txt that is accompanied with an entry into the WordPress Plugin Competition. Also, if you make any changes to that format in the wiki, please make sure there is a VERY GOOD reason to do so and please make sure you leave a note with your name and the reason for the edit at the bottom of the page. Any random and uncommented changes will be reversed.




  1. Eric Meyer (4 comments.) says:

    Shouldn’t the plugin name be a generic “Plugin Name” (or similar) rather than “Staticize Reloaded”? I’d have edited the page to say that myself, but I decided I’d ask the author rather than start changing your work unannounced.

  2. Mark (118 comments.) says:

    Heh, yes Eric. Thanks for the heads up! :)

  3. Trevor (2 comments.) says:

    Is this going to be added to

  4. Aaron (14 comments.) says:

    I have a problem with the last section about screenshots. One can neither embed an image, nor hyperlink in a text file….

  5. Kafkaesquí (1 comments.) says:

    I’ll reinforce Trevor’s question. Once this is formalized it should be given space on Codex.

  6. Geof F. Morris (19 comments.) says:

    Absolutely. We have to stop the Balkanization of WP information. :)

  7. Mark (118 comments.) says:

    I believe that the codex is where this is destined. This temporary location will be changed soon.

Obviously Powered by WordPress. © 2003-2013

page counter