=== Plugin Name === Contributors: (this should be a list of wordpress.org userid's) Donate link: https://developerravi.com/ Tags: comments, spam Requires at least: 3.0.1 Tested up to: 3.4 Stable tag: 4.3 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html
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 Markdown parsed.
A few notes about the sections above:
Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use /trunk/
for
stable.
Note that the readme.txt
of the stable tag is the one that is considered the defining one for the plugin, so
if the /trunk/readme.txt
file says that the stable tag is 4.3
, then it is /tags/4.3/readme.txt
that'll be used
for displaying information about the plugin. In this situation, the only thing considered from the trunk readme.txt
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk readme.txt
to 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.txt
points 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.
e.g.
appreciate.php
to the /wp-content/plugins/
directory<?php 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 ==
/assets/screenshot-1.png
would win over /tags/4.3/screenshot-1.png
(or jpg, jpeg, gif).== Changelog ==
= 1.0 =
= 0.5 =
== 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 ==
Ordered list:
Unordered list:
Here's a link to WordPress and one to Markdown's Syntax Documentation. Titles are optional, naturally.
"Markdown is what the parser uses to process much of the readme file"
Markdown uses email style notation for blockquotes and I've been told:
Asterisks for emphasis. Double it up for strong.
<?php code(); // goes in backticks ?>