1 | === Plugin Name === |
---|
2 | Contributors: (this should be a list of wordpress.org userid's) |
---|
3 | Donate link: http://example.com/ |
---|
4 | Tags: comments, spam |
---|
5 | Requires at least: 4.6 |
---|
6 | Tested up to: 4.7 |
---|
7 | Stable tag: 4.3 |
---|
8 | Requires PHP: 5.2 |
---|
9 | License: GPLv2 or later |
---|
10 | License URI: https://www.gnu.org/licenses/gpl-2.0.html |
---|
11 | |
---|
12 | Here is a short description of the plugin. This should be no more than 150 characters. No markup here. |
---|
13 | |
---|
14 | == Description == |
---|
15 | |
---|
16 | This is the long description. No limit, and you can use Markdown (as well as in the following sections). |
---|
17 | |
---|
18 | For backwards compatibility, if this section is missing, the full length of the short description will be used, and |
---|
19 | Markdown parsed. |
---|
20 | |
---|
21 | A few notes about the sections above: |
---|
22 | |
---|
23 | * "Contributors" is a comma separated list of wordpress.org usernames |
---|
24 | * "Tags" is a comma separated list of tags that apply to the plugin |
---|
25 | * "Requires at least" is the lowest version that the plugin will work on |
---|
26 | * "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on |
---|
27 | higher versions... this is just the highest one you've verified. |
---|
28 | * Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for |
---|
29 | stable. |
---|
30 | |
---|
31 | Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so |
---|
32 | 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 |
---|
33 | for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt` |
---|
34 | is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in |
---|
35 | your in-development version, without having that information incorrectly disclosed about the current stable version |
---|
36 | that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag. |
---|
37 | |
---|
38 | If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where |
---|
39 | you put the stable version, in order to eliminate any doubt. |
---|
40 | |
---|
41 | == Installation == |
---|
42 | |
---|
43 | This section describes how to install the plugin and get it working. |
---|
44 | |
---|
45 | e.g. |
---|
46 | |
---|
47 | 1. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly. |
---|
48 | 1. Activate the plugin through the 'Plugins' screen in WordPress |
---|
49 | 1. Use the Settings->Plugin Name screen to configure the plugin |
---|
50 | 1. (Make your instructions match the desired user flow for activating and installing your plugin. Include any steps that might be needed for explanatory purposes) |
---|
51 | |
---|
52 | |
---|
53 | == Frequently Asked Questions == |
---|
54 | |
---|
55 | = A question that someone might have = |
---|
56 | |
---|
57 | An answer to that question. |
---|
58 | |
---|
59 | = What about foo bar? = |
---|
60 | |
---|
61 | Answer to foo bar dilemma. |
---|
62 | |
---|
63 | == Screenshots == |
---|
64 | |
---|
65 | 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from |
---|
66 | the /assets directory or the directory that contains the stable readme.txt (tags or trunk). Screenshots in the /assets |
---|
67 | directory take precedence. For example, `/assets/screenshot-1.png` would win over `/tags/4.3/screenshot-1.png` |
---|
68 | (or jpg, jpeg, gif). |
---|
69 | 2. This is the second screen shot |
---|
70 | |
---|
71 | == Changelog == |
---|
72 | |
---|
73 | = 1.0 = |
---|
74 | * A change since the previous version. |
---|
75 | * Another change. |
---|
76 | |
---|
77 | = 0.5 = |
---|
78 | * List versions from most recent at top to oldest at bottom. |
---|
79 | |
---|
80 | == Upgrade Notice == |
---|
81 | |
---|
82 | = 1.0 = |
---|
83 | Upgrade notices describe the reason a user should upgrade. No more than 300 characters. |
---|
84 | |
---|
85 | = 0.5 = |
---|
86 | This version fixes a security related bug. Upgrade immediately. |
---|
87 | |
---|
88 | == Arbitrary section == |
---|
89 | |
---|
90 | You may provide arbitrary sections, in the same format as the ones above. This may be of use for extremely complicated |
---|
91 | plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or |
---|
92 | "installation." Arbitrary sections will be shown below the built-in sections outlined above. |
---|
93 | |
---|
94 | == A brief Markdown Example == |
---|
95 | |
---|
96 | Ordered list: |
---|
97 | |
---|
98 | 1. Some feature |
---|
99 | 1. Another feature |
---|
100 | 1. Something else about the plugin |
---|
101 | |
---|
102 | Unordered list: |
---|
103 | |
---|
104 | * something |
---|
105 | * something else |
---|
106 | * third thing |
---|
107 | |
---|
108 | Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax]. |
---|
109 | Titles are optional, naturally. |
---|
110 | |
---|
111 | [markdown syntax]: http://daringfireball.net/projects/markdown/syntax |
---|
112 | "Markdown is what the parser uses to process much of the readme file" |
---|
113 | |
---|
114 | Markdown uses email style notation for blockquotes and I've been told: |
---|
115 | > Asterisks for *emphasis*. Double it up for **strong**. |
---|
116 | |
---|
117 | `<?php code(); // goes in backticks ?>` |
---|