updates 14.1.0 → 14.2.0

package/README.md

@@ -3,7 +3,7 @@
 
 ![](./screenshot.png)
 
-`updates` is a CLI tool which checks for npm dependency updates of the current project and optionally updates `package.json`. It is highly configurable and is typically able to complete in less than a second.
+`updates` is a CLI tool which checks for npm and pypi dependency updates of the current project and optionally updates `package.json`. It is highly configurable and is typically able to complete in less than a second.
 
 # Usage
 
@@ -11,7 +11,7 @@
 # check for updates
 npx updates
 
-# update package.json and install them
+# update package.json and install new dependencies
 npx updates -u && npm i
 ```
 
@@ -24,42 +24,11 @@ deno run -A npm:updates
 
 ## Options
 
-See `--help` or below for the available options. Option that take multiple arguments can take them either via comma-separated value or by specifying the option multiple times. If an option has a optional `pkg` argument but none is given, the option will be applied to all packages instead.
-
-```
-usage: updates [options]
-
-  Options:
-    -u, --update                       Update versions and write package.json
-    -p, --prerelease [<pkg,...>]       Consider prerelease versions
-    -R, --release [<pkg,...>]          Only use release versions, may downgrade
-    -g, --greatest [<pkg,...>]         Prefer greatest over latest version
-    -i, --include <pkg,...>            Include only given packages
-    -e, --exclude <pkg,...>            Exclude given packages
-    -t, --types <type,...>             Check only given dependency types
-    -P, --patch [<pkg,...>]            Consider only up to semver-patch
-    -m, --minor [<pkg,...>]            Consider only up to semver-minor
-    -d, --allow-downgrade [<pkg,...>]  Allow version downgrades when using latest version
-    -E, --error-on-outdated            Exit with code 2 when updates are available and 0 when not
-    -U, --error-on-unchanged           Exit with code 0 when updates are available and 2 when not
-    -r, --registry <url>               Override npm registry URL
-    -G, --githubapi <url>              Override Github API URL
-    -f, --file <path>                  Use given package.json file or module directory
-    -S, --sockets <num>                Maximum number of parallel HTTP sockets opened. Default: 96
-    -j, --json                         Output a JSON object
-    -n, --no-color                     Disable color output
-    -v, --version                      Print the version
-    -V, --verbose                      Print verbose output to stderr
-    -h, --help                         Print this help
-
-  Examples:
-    $ updates
-    $ updates -u && npm i
-```
+See `--help`. Options that take multiple arguments can take them either via comma-separated value or by specifying the option multiple times. If an option has a optional `pkg` argument but none is given, the option will be applied to all packages instead.
 
 ## Config File
 
-Put a `updates.config.js` or `updates.config.mjs` in the root of your project, usually besides `package.json` to configure certain options of the module. CLI arguments have precedence over them.
+Put a `updates.config.js` or `updates.config.mjs` in the root of your project, usually besides `package.json` to configure certain options of the module. CLI arguments have precedence over options in the config file.
 
 ```js
 export default {
@@ -71,8 +40,9 @@ export default {
 
 ### Config Options
 
-- `include` *[]String*: Array of dependencies to include
-- `exclude` *[]String*: Array of dependencies to exclude
-- `types` *[]String*: Array of dependency types
+- `include` *Array<String>*: Array of dependencies to include
+- `exclude` *Array<String>*: Array of dependencies to exclude
+- `types` *Array<String>*: Array of dependency types
+- `registry` *String*: URL to npm registry
 
 © [silverwind](https://github.com/silverwind), distributed under BSD licence