You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.5KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. # spdx-license-ids
  2. [![npm version](https://img.shields.io/npm/v/spdx-license-ids.svg)](https://www.npmjs.com/package/spdx-license-ids)
  3. [![Github Actions](https://action-badges.now.sh/shinnn/spdx-license-ids)](https://wdp9fww0r9.execute-api.us-west-2.amazonaws.com/production/results/shinnn/spdx-license-ids)
  4. A list of [SPDX license](https://spdx.org/licenses/) identifiers
  5. ## Installation
  6. [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/about-npm/):
  7. ```
  8. npm install spdx-license-ids
  9. ```
  10. ## [Node.js](https://nodejs.org/) API
  11. ### require('spdx-license-ids')
  12. Type: `string[]`
  13. All license IDs except for the currently deprecated ones.
  14. ```javascript
  15. const ids = require('spdx-license-ids');
  16. //=> ['0BSD', 'AAL', 'ADSL', 'AFL-1.1', 'AFL-1.2', 'AFL-2.0', 'AFL-2.1', 'AFL-3.0', 'AGPL-1.0-only', ...]
  17. ids.includes('BSD-3-Clause'); //=> true
  18. ids.includes('CC-BY-1.0'); //=> true
  19. ids.includes('GPL-3.0'); //=> false
  20. ```
  21. ### require('spdx-license-ids/deprecated')
  22. Type: `string[]`
  23. Deprecated license IDs.
  24. ```javascript
  25. const deprecatedIds = require('spdx-license-ids/deprecated');
  26. //=> ['AGPL-1.0', 'AGPL-3.0', 'GFDL-1.1', 'GFDL-1.2', 'GFDL-1.3', 'GPL-1.0', 'GPL-2.0', ...]
  27. deprecatedIds.includes('BSD-3-Clause'); //=> false
  28. deprecatedIds.includes('CC-BY-1.0'); //=> false
  29. deprecatedIds.includes('GPL-3.0'); //=> true
  30. ```
  31. ## License
  32. [Creative Commons Zero v1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/deed)