www.aleph1.co.uk Git - yaffs-website/blob - node_modules/spdx-license-ids/README.md

   1 # spdx-license-ids
   2
   3 A list of [SPDX license](https://spdx.org/licenses/) identifiers
   4
   5 [**Download JSON**](https://raw.githubusercontent.com/shinnn/spdx-license-ids/master/spdx-license-ids.json)
   6
   7 ## Use as a JavaScript Library
   8
   9 [![NPM version](https://img.shields.io/npm/v/spdx-license-ids.svg)](https://www.npmjs.org/package/spdx-license-ids)
  10 [![Bower version](https://img.shields.io/bower/v/spdx-license-ids.svg)](https://github.com/shinnn/spdx-license-ids/releases)
  11 [![Build Status](https://travis-ci.org/shinnn/spdx-license-ids.svg?branch=master)](https://travis-ci.org/shinnn/spdx-license-ids)
  12 [![Coverage Status](https://img.shields.io/coveralls/shinnn/spdx-license-ids.svg)](https://coveralls.io/r/shinnn/spdx-license-ids)
  13 [![devDependency Status](https://david-dm.org/shinnn/spdx-license-ids/dev-status.svg)](https://david-dm.org/shinnn/spdx-license-ids#info=devDependencies)
  14
  15 ### Installation
  16
  17 #### Package managers
  18
  19 ##### [npm](https://www.npmjs.com/)
  20
  21 ```sh
  22 npm install spdx-license-ids
  23 ```
  24
  25 ##### [bower](http://bower.io/)
  26
  27 ```sh
  28 bower install spdx-license-ids
  29 ```
  30
  31 ##### [Duo](http://duojs.org/)
  32
  33 ```javascript
  34 const spdxLicenseIds = require('shinnn/spdx-license-ids');
  35 ```
  36
  37 #### Standalone
  38
  39 [Download the script file directly.](https://raw.githubusercontent.com/shinnn/spdx-license-ids/master/spdx-license-ids-browser.js)
  40
  41 ### API
  42
  43 #### spdxLicenseIds
  44
  45 Type: `Array` of `String`
  46
  47 It returns an array of SPDX license identifiers.
  48
  49 ```javascript
  50 const spdxLicenseIds = require('spdx-license-ids'); //=> ['Glide', 'Abstyles', 'AFL-1.1', ... ]
  51 ```
  52
  53 ## License
  54
  55 [The Unlicense](./LICENSE).