Skip to content

Commit 92041cc

Browse files
committed
package.json -> jquery.json docs
1 parent 31b198e commit 92041cc

File tree

1 file changed

+28
-27
lines changed

1 file changed

+28
-27
lines changed

docs/package.md renamed to docs/jquery.json.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
Specification of the jQuery Plugins Site package.json
2-
=====================================================
1+
Specification of the jQuery Plugins Site jquery.json
2+
====================================================
33

4-
# LIVING SPEC (heavily inspired by that of npm. Thanks isaacs)
4+
# LIVING SPEC (heavily inspired by that of npm, thanks isaacs)
55

6-
This document is all you need to know about what's required in your package.json
7-
file. It must be actual JSON, not just a JavaScript object literal.
6+
This document is all you need to know about what's required in your jquery.json
7+
file(s). It must be actual JSON, not just a JavaScript object literal.
8+
9+
**NOTE: While we refer to the file as jquery.json, the file name must actually be {name}.jquery.json.**
810

911
# Fields
1012

@@ -15,44 +17,41 @@ file. It must be actual JSON, not just a JavaScript object literal.
1517
* <a href="#field-title">title</a>
1618
* <a href="#field-author">author</a>
1719
* <a href="#field-licenses">licenses</a>
18-
* <a href="#field-jquery-dependencies">jquery.dependencies</a>
20+
* <a href="#field-dependencies">dependencies</a>
1921

2022
## Optional Fields
2123

2224
* <a href="#field-description">description</a>
2325
* <a href="#field-keywords">keywords</a>
2426
* <a href="#field-homepage">homepage</a>
25-
* <a href="#field-jquery-docs">jquery.docs</a>
26-
* <a href="#field-jquery-demo">jquery.demo</a>
27-
* <a href="#field-jquery-download">jquery.download</a>
27+
* <a href="#field-docs">docs</a>
28+
* <a href="#field-demo">demo</a>
29+
* <a href="#field-download">download</a>
2830
* <a href="#field-maintainers">maintainers</a>
2931

3032
## <a name="field-name">name</a>
3133

32-
The *most* important things in your package.json are the name and version fields.
34+
The *most* important things in your jquery.json are the name and version fields.
3335
The name and version together form an identifier that is assumed
3436
to be completely unique. Changes to the plugin should come along with
3537
changes to the version.
3638

3739
The name is what your thing is called. Some tips:
3840

39-
* Don't put "js" in the name. It's assumed that it's js, since you're
40-
writing a package.json file.
41-
* Do put "jquery" in the name. This may seem like the opposite advice from the previous
42-
tip, but this is important for projects loading jQuery plugins and non-jQuery plugins
43-
through a module loader.
41+
* Don't put "js" or "jquery" in the name. It's assumed that it's js and jquery, since
42+
you're writing a jquery.json file.
4443
* The name ends up being part of a URL. Any name with non-url-safe characters will
4544
be rejected. The jQuery Plugins Site is UTF-8.
4645
* The name should be short, but also reasonably descriptive.
4746
* You may want to check [the plugins site](http://plugins.jquery.com/)
4847
to see if there's something by that name already, before you get too attached to it.
4948
* If you have a plugin with the same name as a plugin already in the jQuery Plugins
50-
Site, either consider renaming your plugin or namespace it. For example, jQuery UI
51-
plugins are listed with the "jquery.ui." prefix (e.g. jquery.ui.dialog, jquery.ui.autocomplete).
49+
Site, either consider renaming your plugin or namespacing it. For example, jQuery UI
50+
plugins are listed with the "ui." prefix (e.g. ui.dialog, ui.autocomplete).
5251

5352
## <a name="field-version">version</a>
5453

55-
The *most* important things in your package.json are the name and version fields.
54+
The *most* important things in your jquery.json are the name and version fields.
5655
The name and version together form an identifier that is assumed
5756
to be completely unique. Changes to the plugin should come along with
5857
changes to the version. Version number must be a valid semantic version number
@@ -84,7 +83,7 @@ a url property linking to the actual text and an optional "type" property specif
8483
}
8584
]
8685

87-
## <a name="field-jquery-dependencies">jquery.dependencies</a>
86+
## <a name="field-dependencies">dependencies</a>
8887

8988
Dependencies are specified with a simple hash of package name to version
9089
range. The version range is EITHER a string which has one or more
@@ -115,15 +114,15 @@ Keywords may only contain letters, numbers, hyphens, and dots.
115114

116115
The url to the plugin homepage.
117116

118-
## <a name="field-jquery-docs">jquery.docs</a>
117+
## <a name="field-docs">docs</a>
119118

120119
The url to the plugin documentation.
121120

122-
## <a name="field-jquery-demo">jquery.demo</a>
121+
## <a name="field-demo">demo</a>
123122

124123
The url to the plugin demo or demos.
125124

126-
## <a name="field-jquery-download">jquery.download</a>
125+
## <a name="field-download">download</a>
127126

128127
The url to download the plugin. A download URL will be automatically generated
129128
based on the tag in GitHub, but you can specify a custom URL if you'd prefer
@@ -214,12 +213,14 @@ The following are equivalent:
214213
You may not supply a comparator with a version containing an x. Any
215214
digits after the first "x" are ignored.
216215

217-
## <a href="sample">Sample package.json</a>
216+
## <a href="sample">Sample jquery.json</a>
217+
218+
**color.jquery.json**
218219

219220
```json
220221
{
221-
"name": "jquery.color",
222-
"version": "2.0.0b1",
222+
"name": "color",
223+
"version": "2.0.0-beta.1",
223224
"title": "jQuery.Color()",
224225
"author": {
225226
"name": "John Resig",
@@ -228,11 +229,11 @@ digits after the first "x" are ignored.
228229
"licenses": [
229230
{
230231
"type": "MIT",
231-
"url": "MIT-LICENSE.txt"
232+
"url": "https://github.com/jquery/jquery-color/raw/2.0.0-beta.1/MIT-LICENSE.txt"
232233
},
233234
{
234235
"type": "GPLv2",
235-
"url": "GPL-LICENSE.txt"
236+
"url": "https://github.com/jquery/jquery-color/raw/2.0.0-beta.1/GPL-LICENSE.txt"
236237
}
237238
],
238239
"jquery": {

0 commit comments

Comments
 (0)