Skip to content

Commit

Permalink
Document CLI options in Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
timoxley committed Dec 4, 2014
1 parent 11e204c commit d189623
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,22 @@ scanning ./yui-lint
└─ repository: http://github.com/yui/yui-lint
```

You can also specify `--unknown` to only show licenses that it can't determine or guessed at (from README)
Options
-------

Also supports `--json /path/to/save.json` to export the data.
* `--unknown` to only show licenses that it can't determine or guess at (from README)
* `--json` output in json format.
* `--csv` output in csv format.
* `--out [filepath]` write the data to a specific file.

Added support for `--csv /path/to/save.csv` to export the data as comma-separated values.
Examples
--------

```
license-checker --json > /path/to/licenses.json
license-checker --csv --out /path/to/licenses.csv
license-checker --unknown
```

Requiring
---------
Expand Down

0 comments on commit d189623

Please sign in to comment.