diff options
Diffstat (limited to 'deps/npm/docs/content/configuring-npm/package-json.md')
| -rw-r--r-- | deps/npm/docs/content/configuring-npm/package-json.md | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/deps/npm/docs/content/configuring-npm/package-json.md b/deps/npm/docs/content/configuring-npm/package-json.md index 5b4acf187f7..be50e453ef4 100644 --- a/deps/npm/docs/content/configuring-npm/package-json.md +++ b/deps/npm/docs/content/configuring-npm/package-json.md @@ -18,11 +18,9 @@ settings described in [`config`](/using-npm/config). If you plan to publish your package, the *most* important things in your package.json are the name and version fields as they will be required. The name and version together form an identifier that is assumed to be -completely unique. Changes to the package should come along with changes -to the version. If you don't plan to publish your package, the name and +completely unique. If you don't plan to publish your package, the name and version fields are optional. - -The name is what your thing is called. +The name field contains your package name. Some rules: @@ -52,12 +50,9 @@ A name can be optionally prefixed by a scope, e.g. `@myorg/mypackage`. See ### version -If you plan to publish your package, the *most* important things in your -package.json are the name and version fields as they will be required. The -name and version together form an identifier that is assumed to be -completely unique. Changes to the package should come along with changes -to the version. If you don't plan to publish your package, the name and -version fields are optional. +Changes to the package should come along with changes to the version. +You can show developers how much they need to adjust on a new update by +using [semantic versioning](../../about-semantic-versioning) Version must be parseable by [node-semver](https://github.com/npm/node-semver), which is bundled with |