w33ble/pkgcomp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Compare commits

base: w33ble:609a36c1282f99df595e8dc55ce2248ca1dc2573
Branches Tags
w33ble:master
..
compare: w33ble:3f29429d1a4bc84d313eb4f1e343d34e836747ad
Branches Tags
w33ble:master

1 Commits
609a36c128 ... 3f29429d1a

Author SHA1 Message Date
joe fleming
3f29429d1a docs: add usage info to readme 2019-04-04 17:10:24 -07:00
1 changed files with 2 additions and 2 deletions
Expand all files Collapse all files

4
README.md
View File

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