Skip to content

Commit 2cba6d0

Browse files
committed
README: Cleanup.
1 parent 60ba56d commit 2cba6d0

File tree

1 file changed

+41
-30
lines changed

1 file changed

+41
-30
lines changed

README.md

+41-30
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,29 @@ The jQuery Plugins site, http://plugins.jquery.com/
44

55
### How it works
66

7-
The plugins site is an index of GitHub repositories that contain jQuery plugins. The repositories can contain one or many jQuery plugin with an accompanying valid `plugin.jquery.json` manifest file in the repository root. The specification for this file lives [here](http://plugins.jquery.com/docs/package-manifest).
7+
The plugins site is an index of GitHub repositories that contain jQuery plugins.
8+
The repositories can contain one or many jQuery plugin with an accompanying
9+
valid `plugin.jquery.json` manifest file in the repository root. The
10+
specification for this file lives [here](http://plugins.jquery.com/docs/package-manifest).
811

912
### How to list a plugin
1013

11-
Simply add a [post-receive hook](http://help.github.com/post-receive-hooks/) to your repository with our web hook url, `http://plugins.jquery.com/postreceive-hook.`. When you push
12-
to your repository, the plugins site will look at your repository's tags and their corresponding manifest file (thepluginname.jquery.json). You can read up on this process,
13-
as well as the requirements of the manifest file on [the jQuery Plugins Site](http://plugins.jquery.com/docs/publish/).
14+
Simply add a [post-receive hook](http://help.github.com/post-receive-hooks/) to
15+
your repository with our Web Hook URL, `http://plugins.jquery.com/postreceive-hook.`.
16+
When you push to your repository, the plugins site will look at your repository's
17+
tags and their corresponding manifest file (thepluginname.jquery.json). You can
18+
read up on this process, as well as the requirements of the manifest file on
19+
[the jQuery Plugins Site](http://plugins.jquery.com/docs/publish/).
1420

15-
Assuming there were no errors in your manifest file, your plugin should be on the plugins site within one to two minutes after pushing to github. If you
16-
still don't see your plugin listed, you can click the "Test Hook" button on the same page you added the service hook to your repository and the
17-
plugins site will re-query github for changes, in case github didn't update your repository in time.
21+
Assuming there were no errors in your manifest file, your plugin should be on
22+
the plugins site within a minute after pushing to GitHub. If you still don't see
23+
your plugin listed, check the [error log](http://plugins.jquery.com/error.log).
1824

19-
We are currently exploring options to provide feedback on errors encountered during the process of adding your
20-
plugin to the plugins site. If you are still encountering issues after verifying the post-receive hook is in
21-
place and that your manifest file is valid, ask for assistance in #jquery-content on [freenode.net](http://freenode.net).
25+
We are currently exploring options to provide better feedback on errors encountered
26+
during the process of adding your plugin to the plugins site. If you are still
27+
encountering issues after verifying the post-receive hook is in place and that
28+
your manifest file is valid, ask for assistance in #jquery-content
29+
on [freenode.net](http://freenode.net).
2230

2331
## Development
2432

@@ -42,40 +50,43 @@ place and that your manifest file is valid, ask for assistance in #jquery-conten
4250

4351
1. Follow https://github.com/joyent/node/wiki/Installation
4452

45-
You can also install [nave](https://github.com/isaacs/nave), a node version manager. You can easily install it
46-
using [nave-installer](https://github.com/danheberden/nave-installer) or download it manually.
53+
You can also install [nave](https://github.com/isaacs/nave), a node version manager.
54+
You can easily install it using [nave-installer](https://github.com/danheberden/nave-installer)
55+
or download it manually.
4756

4857
#### plugins.jquery.com setup
4958

5059
To build and deploy your changes for previewing in a
5160
[`jquery-wp-content`](https://github.com/jquery/jquery-wp-content) instance,
52-
follow the [workflow instructions](http://contribute.jquery.org/web-sites/#workflow) from our
53-
documentation on [contributing to jQuery Foundation web sites](http://contribute.jquery.org/web-sites/).
61+
follow the [workflow instructions](http://contribute.jquery.org/web-sites/#workflow)
62+
from our documentation on
63+
[contributing to jQuery Foundation web sites](http://contribute.jquery.org/web-sites/).
5464

55-
If you want to setup and ultimately run the node scripts that manage plugin entries, run `grunt setup`.
56-
If you need to clear the db or are getting and error running `grunt setup` regarding the setupdb or
57-
retrydb tasks failing, run `grunt clean-all`.
65+
If you want to setup and ultimately run the node scripts that manage plugin
66+
entries, run `grunt setup`. If you need to clear the db or are getting and error
67+
running `grunt setup` regarding the setupdb or retrydb tasks failing,
68+
run `grunt clean-all`.
5869

59-
If you have made changes to the documentation and simply want to deploy or update that content, run
60-
`grunt update`.
70+
If you have made changes to the documentation and simply want to deploy or update
71+
that content, run `grunt update`.
6172

6273
#### Running the site for development and debugging
6374

64-
1. `node scripts/update-server.js --console` will start the update server and log its output
65-
to the terminal window. This will *not* update wordpress, but will let you see the result of
66-
adding a plugin locally.
75+
1. `node scripts/update-server.js --console` will start the update server and
76+
log its output to the terminal window. This will *not* update wordpress, but
77+
will let you see the result of adding a plugin locally.
6778

68-
2. `node scripts/wordpress-update.js --console` will process the changes in sqlite into
69-
entries in wordpress. Note, if you're re-adding plugins that have already been added, you
70-
will need to remove those entries from wordpress.
79+
2. `node scripts/wordpress-update.js --console` will process the changes in
80+
sqlite into entries in wordpress. Note, if you're re-adding plugins that have
81+
already been added, you will need to remove those entries from wordpress.
7182

7283
### Running the site normally
7384

74-
`node scripts/manager.js` runs the update-server and wordpress-update scripts automatically.
75-
However, because it handless restarts/failures of these scripts, it is harder to stop this
76-
process (you have to kill the pid's from the processes' pid file). Also, running the servers
77-
manually and individually is much easier for development, as you will probably only *need*
78-
update-server.js running.
85+
`node scripts/manager.js` runs the update-server and wordpress-update scripts
86+
automatically. However, because it handless restarts/failures of these scripts,
87+
it is harder to stop this process. Also, running the servers manually and
88+
individually is much easier for development, as you will probably only *need*
89+
update-server.js running.
7990

8091
### Transferring ownership of a plugin
8192

0 commit comments

Comments
 (0)