add usage to readme

This commit is contained in:
silverwind 2018-09-02 10:35:47 +02:00
parent fecbaa57f0
commit 82b0a92e57
Signed by: silverwind
GPG Key ID: 2E62B41C93869443

@ -14,7 +14,32 @@
$ npm i -g updates
```
# Usage
```
usage: updates [options]
Options:
-u, --update Update package.json
-p, --prerelease Consider prerelease versions
-j, --json Output a JSON object
-g, --greatest Prefer greatest over latest version
-i, --include <pkg,...> Only include given packages
-e, --exclude <pkg,...> Exclude given packages
-r, --registry <url> Use a custom registry
-f, --file <path> Use specified package.json file
-c, --color Force-enable color output
-n, --no-color Disable color output
-v, --version Print the version
-h, --help Print this help
Examples:
$ updates
$ updates -u
$ updates -u -e semver
``
## Examples
### Check for updates
```console
$ updates