Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKyle Mitchell <kyle@kemitchell.com>2015-06-19 09:09:04 +0300
committerForrest L Norvell <forrest@npmjs.com>2015-06-19 11:37:10 +0300
commit16a3dd545b10f8a2464e2037506ce39124739b41 (patch)
tree88049edf14449ebda816ba48c795b06bb7ae8f07 /doc
parent4827fc784117c17f35dd9b51b21d1eff6094f661 (diff)
docs: "UNLICENSED" and "SEE LICENSE IN <filename>"
Fixes: #8557 PR-URL: https://github.com/npm/npm/pull/8609
Diffstat (limited to 'doc')
-rw-r--r--doc/files/package.json.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/files/package.json.md b/doc/files/package.json.md
index ad2b6623a..f402e2ebc 100644
--- a/doc/files/package.json.md
+++ b/doc/files/package.json.md
@@ -115,9 +115,9 @@ expression syntax version 2.0 string](http://npmjs.com/package/spdx), like this:
If you are using a license that hasn't been assigned an SPDX identifier, or if
you are using a custom license, use the following valid SPDX expression:
- { "license" : "LicenseRef-LICENSE" }
+ { "license" : "SEE LICENSE IN <filename>" }
-Then include a LICENSE file at the top level of the package.
+Then include a file named `<filename>` at the top level of the package.
Some old packages used license objects or a "licenses" property containing an
array of license objects:
@@ -147,6 +147,13 @@ Those styles are now deprecated. Instead, use SPDX expressions, like this:
{ "license": "(MIT OR Apache-2.0)" }
+Finally, if you do not wish to grant others the right to use a private or
+unpublished package under any terms:
+
+ { "license": "UNLICENSED"}
+
+Consider also setting `"private": true` to prevent accidental publication.
+
## people fields: author, contributors
The "author" is one person. "contributors" is an array of people. A "person"