aboutsummaryrefslogtreecommitdiff
path: root/node_modules/spdx-license-ids/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/spdx-license-ids/README.md')
-rw-r--r--[-rwxr-xr-x]node_modules/spdx-license-ids/README.md57
1 files changed, 27 insertions, 30 deletions
diff --git a/node_modules/spdx-license-ids/README.md b/node_modules/spdx-license-ids/README.md
index 92523532b..c7b5b5f32 100755..100644
--- a/node_modules/spdx-license-ids/README.md
+++ b/node_modules/spdx-license-ids/README.md
@@ -1,55 +1,52 @@
# spdx-license-ids
-A list of [SPDX license](https://spdx.org/licenses/) identifiers
-
-[**Download JSON**](https://raw.githubusercontent.com/shinnn/spdx-license-ids/master/spdx-license-ids.json)
-
-## Use as a JavaScript Library
-
-[![NPM version](https://img.shields.io/npm/v/spdx-license-ids.svg)](https://www.npmjs.org/package/spdx-license-ids)
-[![Bower version](https://img.shields.io/bower/v/spdx-license-ids.svg)](https://github.com/shinnn/spdx-license-ids/releases)
+[![npm version](https://img.shields.io/npm/v/spdx-license-ids.svg)](https://www.npmjs.org/package/spdx-license-ids)
[![Build Status](https://travis-ci.org/shinnn/spdx-license-ids.svg?branch=master)](https://travis-ci.org/shinnn/spdx-license-ids)
-[![Coverage Status](https://img.shields.io/coveralls/shinnn/spdx-license-ids.svg)](https://coveralls.io/r/shinnn/spdx-license-ids)
-[![devDependency Status](https://david-dm.org/shinnn/spdx-license-ids/dev-status.svg)](https://david-dm.org/shinnn/spdx-license-ids#info=devDependencies)
-### Installation
+A list of [SPDX license](https://spdx.org/licenses/) identifiers
-#### Package managers
+## Installation
-##### [npm](https://www.npmjs.com/)
+[Download JSON directly](https://raw.githubusercontent.com/shinnn/spdx-license-ids/master/index.json), or [use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm):
-```sh
+```
npm install spdx-license-ids
```
-##### [bower](http://bower.io/)
+## [Node.js](https://nodejs.org/) API
-```sh
-bower install spdx-license-ids
-```
+### require('spdx-license-ids')
-##### [Duo](http://duojs.org/)
+Type: `<Array<string>>`
-```javascript
-const spdxLicenseIds = require('shinnn/spdx-license-ids');
-```
+All license IDs except for the currently deprecated ones.
-#### Standalone
+```javascript
+const ids = require('spdx-license-ids');
+//=> ['0BSD', 'AAL', 'Abstyles', 'Adobe-2006', 'Adobe-Glyph', 'ADSL', 'AFL-1.1', 'AFL-1.2', ...]
-[Download the script file directly.](https://raw.githubusercontent.com/shinnn/spdx-license-ids/master/spdx-license-ids-browser.js)
+ids.includes('BSD-3-Clause'); //=> true
+ids.includes('CC-BY-1.0'); //=> true
-### API
+ids.includes('GPL-3.0'); //=> false
+```
-#### spdxLicenseIds
+### require('spdx-license-ids/deprecated')
-Type: `Array` of `String`
+Type: `<Array<string>>`
-It returns an array of SPDX license identifiers.
+Deprecated license IDs.
```javascript
-const spdxLicenseIds = require('spdx-license-ids'); //=> ['Glide', 'Abstyles', 'AFL-1.1', ... ]
+const deprecatedIds = require('spdx-license-ids/deprecated');
+//=> ['AGPL-1.0', 'AGPL-3.0', 'eCos-2.0', 'GFDL-1.1', 'GFDL-1.2', 'GFDL-1.3', 'GPL-1.0', ...]
+
+deprecatedIds.includes('BSD-3-Clause'); //=> false
+deprecatedIds.includes('CC-BY-1.0'); //=> false
+
+deprecatedIds.includes('GPL-3.0'); //=> true
```
## License
-[The Unlicense](./LICENSE).
+[Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/deed)