Compare commits

..

1 Commits

Author SHA1 Message Date
609a36c128 docs: add usage info to readme 2019-04-04 17:08:24 -07:00

View File

@@ -54,7 +54,7 @@ Configuration is provided as JSON, and can be defined in any of the following (l
### Config options
Name | Default | Description
---- | ------- | -----------
-- | -- | --
`checkFiles` | `['package-lock.json', 'yarn.lock']` | Additional files to checksum and compare, files that are not included will be skipped
`rootDir` | `process.cwd()` | The root path to your project
`dataDir` | `<Home>/.local/share` | Directory where this module's data should be written to
@@ -88,7 +88,7 @@ As a property in `package.json`:
## CLI Arguments
Argument | Default | Description
-------- | ------- | -----------
-- | -- | --
`--verbose` | `false` | Shows more verbose output, like if the command is being skipped or a file in `checkFiles` does not exist
`--force` | `false` | Runs your command regardless of whether or not there were changes in the package
`--cmd` | | Specify the command to run when changes are found (ex. `--cmd="yarn install"`)