Skip to content
This repository was archived by the owner on Sep 9, 2025. It is now read-only.

Commit d6c957a

Browse files
committed
Changed description of readme.
1 parent ffa9a57 commit d6c957a

File tree

1 file changed

+3
-22
lines changed

1 file changed

+3
-22
lines changed

readme.txt

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,11 @@ GitPress provides a widget for listing a GitHub user's repositories.
88

99
== Description ==
1010

11-
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
11+
GitPress is a WordPress plugin that provides a widget for listing a GitHub user's repositories.
1212

13-
For backwards compatibility, if this section is missing, the full length of the short description will be used, and
14-
Markdown parsed.
13+
The widget also supports multiple instances just in case you're running a multi-author blog and you all want to show off your GitHub hotness. =D
1514

16-
A few notes about the sections above:
17-
18-
* "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
19-
* "Tags" is a comma separated list of tags that apply to the plugin
20-
* "Requires at least" is the lowest version that the plugin will work on
21-
* "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
22-
higher versions... this is just the highest one you've verified.
23-
* Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
24-
stable.
25-
26-
Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
27-
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
28-
for displaying information about the plugin. In this situation, the only thing considered from the trunk `readme.txt`
29-
is the stable tag pointer. Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
30-
your in-development version, without having that information incorrectly disclosed about the current stable version
31-
that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
32-
33-
If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
34-
you put the stable version, in order to eliminate any doubt.
15+
Follow the project on GitHub too! http://github.com/enricob/gitpress
3516

3617
== Installation ==
3718

0 commit comments

Comments
 (0)