diff options
Diffstat (limited to 'deps/npm/node_modules/init-package-json/node_modules/validate-npm-package-license/README.md')
-rw-r--r-- | deps/npm/node_modules/init-package-json/node_modules/validate-npm-package-license/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/deps/npm/node_modules/init-package-json/node_modules/validate-npm-package-license/README.md b/deps/npm/node_modules/init-package-json/node_modules/validate-npm-package-license/README.md new file mode 100644 index 000000000..904f74b9d --- /dev/null +++ b/deps/npm/node_modules/init-package-json/node_modules/validate-npm-package-license/README.md @@ -0,0 +1,29 @@ +npm-validate-package-license +============================ + +Give me a string and I'll tell you if it's a valid npm package license. + +*This package is not endorsed or approved by npm. It is part of a proposal to add license field validation to the npm command-line interface.* + +<!-- js var valid = require('./'); --> + +```js +var validResult = { + validForNewPackages: true, + validForOldPackages: true +}; + +valid('Apache-2.0'); // => validResult +valid('GPL-3.0 OR BSD-2-Clause'); // => validResult + +var invalidResult = { + validForOldPackages: false, + validForNewPackages: false, + warnings: [ + 'license should be a valid SPDX license expression', + 'license is similar to the valid expression "Apache-2.0"' + ] +}; + +valid('Apache 2.0'); // => invalidResult +``` |