From 5f2f202f496e5c4286dd6269f62967f73e75c1c3 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Sat, 2 Jan 2021 20:46:48 +0100 Subject: [PATCH] Updated desctiption and options in readme [SKIP CI] --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 22985a4..1db1071 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ [![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. +You can export this information into json(even prettyfied) and markdown. +We use this in our open source projects to credit the awesome work of other open source contributors. ## Install Via yarn/npm: @@ -21,10 +22,14 @@ Export all dependencies to json: `licenseexporter --json --recursive` Export only your dependencies to markdown: `licenseexporter --md` Export all dependencies to markdown: `licenseexporter --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 \ No newline at end of file +## Options +Arg | Description | Type | Default +- | - | - | - +-j, --json | Exports the license information into ./licenses.json as json. | flag/[boolean] | N/A +-p, --pretty | Prettify the json output.|flag/[boolean] | N/A +-m, --markdown | Exports the license information into ./licenses.md as markdown. | flag/[boolean] | N/A +-r, --recursive | Include all of the dependencies' subdependencies. | flag/[boolean] | N/A +-o, --output | Output folder for the exports. | [string] | Current folder +-i, --input | Path to the input folder containing your package.json and node_modules | [string] | Current folder +-h, --help | Show help | flag/[boolean] | N/A +-v, --version | Show version number | flag/[boolean] | N/A \ No newline at end of file