Plugin Readme Generator

Overview

Use this tool to create custom readme.txt file for your WordPress plugin.

Usage

  • Fill in the user-friendly form.
  • Click the “Update Code” button.
  • Copy the code to your project.
  • Or save it as a snippet and share with the community.

Examples

If you are still learning how to use this tool, check out the following examples:

The name of the plugin.
Comma separated list of WordPress.org usernames.
Comma separated list of tags.
Plugin license.
Plugin license URI.
The lowest WordPress version the plugin will work on.
The highest WordPress version the plugin test on.
The lowest PHP version required to run the plugin.
The subversion "tag" of the latest stable version, or "trunk". Default: trunk
Description in 2-3 sentences, up to 150 characters, no markup.
Plugin full description. No characters limit.
Plugin installation instruction.
Plugin frequently asked questions.
Screenshot description.
Screenshot description.
Screenshot description.
List versions from most recent at top to oldest at bottom.
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.
  Save Snippet
=== Test Plugin ===
Contributors: user, user, user
Tags: tag, tag, tag
Donate link: http://example.com/
Requires at least: 3.0.1
Tested up to: 3.6
Stable tag: 4.5
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Short description of this great plugin. No more than 150 characters, no markup.

== Description ==
Long description of this great plugin. No characters limit, and you can use markdown.

For backwards compatibility, if this section is missing, the full length of the short description will be used, and
markdown parsed.

Ordered list:

1. Some feature
1. Another feature
1. Something else about the plugin

Unordered list:

* something
* something else
* third thing

Link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].

Titles are optional, naturally.

Asterisks for *emphasis*.

Double it up  for **strong**.

== Installation ==
1. Upload "test-plugin.php" to the "/wp-content/plugins/" directory.
1. Activate the plugin through the "Plugins" menu in WordPress.
1. Place "do_action( 'plugin_name_hook' );" in your templates.

== Frequently Asked Questions ==
= A question that someone might have =
An answer to that question.

= What about foo bar? =
Answer to foo bar dilemma.

== Screenshots ==
1. The screenshot description corresponds to screenshot-1.(png|jpg|jpeg|gif).
2. The screenshot description corresponds to screenshot-2.(png|jpg|jpeg|gif).
3. The screenshot description corresponds to screenshot-3.(png|jpg|jpeg|gif).

== Changelog ==
= 0.2 =
* A change since the previous version.
* Another change.

= 0.1 =
* Initial release.

== Upgrade Notice ==
= 0.2 =
Upgrade notices describe the reason a user should upgrade

= 0.1 =
This version fixes a security related bug. Upgrade immediately.