Skip to content

Commit ed43284

Browse files
committed
order by importance
1 parent 250a37d commit ed43284

File tree

1 file changed

+50
-50
lines changed

1 file changed

+50
-50
lines changed

README.md

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,6 @@ The name of the package as stored in the registry.
1515
* 50 characters or less.
1616

1717

18-
### version
19-
20-
Type: `String`
21-
22-
The package's semantic version number.
23-
24-
* Must be a [semantic version](http://semver.org) parseable by [node-semver](https://github.com/isaacs/node-semver).
25-
* If publishing a folder, the version must be higher than the version stored in the registry, when republishing.
26-
* Version should only be required if you are not using git tags.
27-
28-
29-
### location
30-
31-
Type: `String`
32-
33-
The endpoint where Bower can find your package. This is used during registration.
34-
35-
3618
### description
3719

3820
*Recommended*
@@ -43,14 +25,15 @@ Any character. Max 140.
4325
Help users identify and search for your package with a brief description. Describe what your package does, rather than what it's made of. Will be displayed in search/lookup results on the CLI and the website that can be used to search for packages.
4426

4527

46-
### keywords
28+
### version
4729

48-
*Recommended*
49-
Type: `Array` of `String`
30+
Type: `String`
5031

51-
Same format requirements as [name](#name).
32+
The package's semantic version number.
5233

53-
Used for search by keyword. Helps make your package easier to discover without people needing to know its name. Recommended.
34+
* Must be a [semantic version](http://semver.org) parseable by [node-semver](https://github.com/isaacs/node-semver).
35+
* If publishing a folder, the version must be higher than the version stored in the registry, when republishing.
36+
* Version should only be required if you are not using git tags.
5437

5538

5639
### main
@@ -65,32 +48,12 @@ The primary acting files necessary to use your package. While Bower does not dir
6548
* Files names should not be versioned (Bad: package.1.1.0.js; Good: package.js).
6649

6750

68-
### dependencies [hash]
69-
70-
Type: `Object`
71-
72-
Dependencies are specified with a simple hash of package name to a semver compatible identifier or URL.
73-
74-
* Key must be a valid [name](#name).
75-
* Value must be a valid [version](#version), a Git URL, or a URL (inc. tarball and zipball).
76-
* Value can be an owner/package shorthand, i.e. owner/package. By default, the shorthand resolves to GitHub -> https://github.com/owner/package. This may be changed in `.bowerrc` shorthand_resolver.
77-
* Local paths may be used as values for local development, but they will be disallowed when registering.
78-
79-
80-
### devDependencies
81-
82-
Type: `Object`
83-
84-
Same rules as `dependencies`.
85-
86-
Dependencies that are only needed for development of the package, e.g., test framework or building documentation.
87-
88-
89-
### resolutions
51+
### license
9052

91-
Type: `Object`
53+
*Recommended*
54+
Type: `String` or `Array` of `String`
9255

93-
Dependency versions to automatically resolve with if conflicts occur between packages.
56+
[SPDX license identifier](https://spdx.org/licenses/) or path/url to a license.
9457

9558

9659
### ignore
@@ -105,12 +68,14 @@ Note: README (all variants of case, .md, .text) and bower.json will never be ign
10568
The ignore rules follow the same rules specified in the [gitignore pattern spec](http://git-scm.com/docs/gitignore).
10669

10770

108-
### license
71+
### keywords
10972

11073
*Recommended*
111-
Type: `String` or `Array` of `String`
74+
Type: `Array` of `String`
11275

113-
[SPDX license identifier](https://spdx.org/licenses/) or path/url to a license.
76+
Same format requirements as [name](#name).
77+
78+
Used for search by keyword. Helps make your package easier to discover without people needing to know its name. Recommended.
11479

11580

11681
### authors
@@ -160,8 +125,43 @@ The repository in which the source code can be found.
160125
```
161126

162127

128+
### dependencies
129+
130+
Type: `Object`
131+
132+
Dependencies are specified with a simple hash of package name to a semver compatible identifier or URL.
133+
134+
* Key must be a valid [name](#name).
135+
* Value must be a valid [version](#version), a Git URL, or a URL (inc. tarball and zipball).
136+
* Value can be an owner/package shorthand, i.e. owner/package. By default, the shorthand resolves to GitHub -> https://github.com/owner/package. This may be changed in `.bowerrc` shorthand_resolver.
137+
* Local paths may be used as values for local development, but they will be disallowed when registering.
138+
139+
140+
### devDependencies
141+
142+
Type: `Object`
143+
144+
Same rules as `dependencies`.
145+
146+
Dependencies that are only needed for development of the package, e.g., test framework or building documentation.
147+
148+
149+
### resolutions
150+
151+
Type: `Object`
152+
153+
Dependency versions to automatically resolve with if conflicts occur between packages.
154+
155+
163156
### private
164157

165158
Type: `Boolean`
166159

167160
If you set it to `true` it will refuse to publish it. This is a way to prevent accidental publication of private repositories.
161+
162+
163+
### location
164+
165+
Type: `String`
166+
167+
The endpoint where Bower can find your package. This is used during registration.

0 commit comments

Comments
 (0)