Here is a short description of the plugin. This should be no more than 150 characters. No markup here.
== Description ==
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
For backwards compatibility, if this section is missing, the full length of the short description will be used, and
A few notes about the sections above:
- “Contributors” is a comma separated list of wordpress.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
Note that the
readme.txtof the stable tag is the one that is considered the defining one for the plugin, so
/trunk/readme.txtfile says that the stable tag is
4.3, then it is
/tags/4.3/readme.txtthat’ll be used
for displaying information about the plugin. In this situation, the only thing considered from the trunk
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk
readme.txtto reflect changes in
your in-development version, without having that information incorrectly disclosed about the current stable version
that lacks those changes — as long as the trunk’s
readme.txtpoints to the correct stable tag.
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.
== Installation ==
This section describes how to install the plugin and get it working.
Upload the plugin files to the
/wp-content/plugins/plugin-namedirectory, or install the plugin through the WordPress plugins screen directly.
- Activate the plugin through the ‘Plugins’ screen in WordPress
- Use the Settings->Plugin Name screen to configure the plugin
- (Make your instructions match the desired user flow for activating and installing your plugin. Include any steps that might be needed for explanatory purposes)
== Screenshots ==
This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets
directory take precedence. For example,
/assets/screenshot-1.pngwould win over
(or jpg, jpeg, gif).
- This is the second screen shot
== Changelog ==
= 1.0 =
- A change since the previous version.
- Another change.
= 0.5 =
- List versions from most recent at top to oldest at bottom.
== Upgrade Notice ==
= 1.0 =
Upgrade notices describe the reason a user should upgrade. No more than 300 characters.
= 0.5 =
This version fixes a security related bug. Upgrade immediately.
== Arbitrary section ==
You may provide arbitrary sections, in the same format as the ones above. 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.” Arbitrary sections will be shown below the built-in sections outlined above.
== A brief Markdown Example ==
- Some feature
- Another feature
- Something else about the plugin
- something else
- third thing
Asterisks for emphasis. Double it up for strong.
<?php code(); // goes in backticks ?>