You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-30
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,29 @@ The jQuery Plugins site, http://plugins.jquery.com/
4
4
5
5
### How it works
6
6
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).
8
11
9
12
### How to list a plugin
10
13
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
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).
18
24
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).
22
30
23
31
## Development
24
32
@@ -42,40 +50,43 @@ place and that your manifest file is valid, ask for assistance in #jquery-conten
0 commit comments