Skip to content

Commit c633b1a

Browse files
author
Dan Butvinik
committed
update readme
1 parent 3d64943 commit c633b1a

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -1 +1,30 @@
11
# @clearlydefined/spdx
2+
3+
ClearlyDefined focused SPDX utility library.
4+
5+
## Install
6+
7+
```
8+
npm install @clearlydefined/spdx
9+
```
10+
11+
```js
12+
const SPDX = require('@clearlydefined/spdx')
13+
14+
SPDX.parse('MIT')
15+
SPDX.stringify({ license: 'MIT' })
16+
SPDX.satisfies('MIT', 'MIT OR Apache-2.0')
17+
SPDX.merge('MIT', 'Apache-2.0', 'AND')
18+
SPDX.expand('MIT or Apache-2.0')
19+
SPDX.normalize('mit')
20+
SPDX.lookupByName('Apache License 2.0')
21+
```
22+
23+
## Local development
24+
25+
```
26+
git clone https://github.com/clearlydefined/spdx
27+
cd spdx
28+
npm i
29+
npm test
30+
```

package.json

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77
"type": "git",
88
"url": "git+https://github.com/clearlydefined/spdx.git"
99
},
10+
"main": "index.js",
11+
"keywords": [
12+
"spdx"
13+
],
14+
"bugs": {
15+
"url": "https://github.com/clearlydefined/spdx/issues"
16+
},
17+
"homepage": "https://github.com/clearlydefined/spdx",
1018
"scripts": {
1119
"test": "nyc mocha \"test.js\" && eslint ."
1220
},

0 commit comments

Comments
 (0)