Skip to content

Commit

Permalink
docs: add config option to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MtBlue81 committed Mar 17, 2024
1 parent 7cc2aa9 commit f8910ae
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ Option for [`workspace` option](https://docs.npmjs.com/cli/v8/commands/npm-query
Specify which package manager to use `npm` or `pnpm`.
Automatically detected if you are running the command with `npm run`, `npx`, or `pnpm run`.

#### `-c`, `--config`

**default: (./license-manager.config.js)**

Config file path.

### Options for `analyze` command

#### `-l`, `--allowLicense`
Expand Down Expand Up @@ -132,6 +138,7 @@ Based on the results of npm query, and some fields be added.

You can write all settings to `license-manager.config.js`.
If `license-manager.config.js` exists in the current directory, it is automatically loaded.
You can change the file path with the --config option.
CLI options take precedence, but license and package specifications are merged.
And you can also specify a override function in case the license and license text cannot be detected.

Expand Down

0 comments on commit f8910ae

Please sign in to comment.