summaryrefslogtreecommitdiff
path: root/desktop/node_modules/spdx-correct/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/node_modules/spdx-correct/README.md')
-rw-r--r--desktop/node_modules/spdx-correct/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/desktop/node_modules/spdx-correct/README.md b/desktop/node_modules/spdx-correct/README.md
new file mode 100644
index 0000000..af563d8
--- /dev/null
+++ b/desktop/node_modules/spdx-correct/README.md
@@ -0,0 +1,22 @@
+## Usage
+
+```javascript
+var correct = require('spdx-correct')
+var assert = require('assert')
+
+assert.strictEqual(correct('mit'), 'MIT')
+
+assert.strictEqual(correct('Apache 2'), 'Apache-2.0')
+
+assert(correct('No idea what license') === null)
+
+// disable upgrade option
+assert(correct('GPL-3.0'), 'GPL-3.0-or-later')
+assert(correct('GPL-3.0', { upgrade: false }), 'GPL-3.0')
+```
+
+## Contributors
+
+spdx-correct has benefited from the work of several contributors.
+See [the GitHub repository](https://github.com/jslicense/spdx-correct.js/graphs/contributors)
+for more information.