Fresh new readme
This commit is contained in:
parent
f1ef8b7837
commit
b6050b0c2f
31
README.md
31
README.md
|
@ -1,3 +1,30 @@
|
|||
# license-exporter
|
||||
# ODIT.Services - License Exporter
|
||||
|
||||
A simple license exporter that crawls your npm dependencies for their licenses.
|
||||
[![Build Status](https://ci.odit.services/api/badges/odit/license-exporter/status.svg?ref=refs/heads/main)](https://ci.odit.services/odit/license-exporter)
|
||||
|
||||
A simple license exporter that crawls your package.json and provides you with information about your dependencies' licenses.
|
||||
You can export this information into json and markdown.
|
||||
|
||||
## Install
|
||||
Via yarn/npm:
|
||||
```bash
|
||||
yarn add @odit/license-exporter
|
||||
# Or
|
||||
npm i @odit/license-exporter
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
Export only your dependencies to json: `license-exporter --json`
|
||||
Export all dependencies to json: `license-exporter --json --recursive`
|
||||
|
||||
Export only your dependencies to markdown: `license-exporter --md`
|
||||
Export all dependencies to markdown: `license-exporter --md --recursive`
|
||||
|
||||
## Arguments
|
||||
Arg | Description
|
||||
-|-
|
||||
`--help` | View the help dialog
|
||||
`--recursive`| Include all dependencies' subdependencies
|
||||
`--json` | Exports the license information into ./licenses.json as json
|
||||
`--md` | Exports the license information into ./licenses.md as markdow
|
Reference in New Issue