diff --git a/README.md b/README.md index 7355459..ae0c890 100644 --- a/README.md +++ b/README.md @@ -32,20 +32,15 @@ purr [-h | --help] [-V | --version] - [`stars`](#stars) - [`whiskers`](#whiskers) - [`init`](#init) -- [`userstyles`](#userstyles) - - [`query`](#query-1) - - [`maintained`](#maintained-1) - - [`has`](#has-1) - - [`init`](#init-1) - [`whiskerify`](#whiskerify) ### `query` ``` -purr query [--for ] [-g | --get] [-c | --count] +purr query [--for ] [-g | --get] [-c | --count] [--userstyles | --no-userstyles | --only-userstyles] ``` -Query the ports.yml data source. With no arguments, all ports are displayed. +Query the ports.yml data source. With no arguments, all ports are displayed. The `--count` and userstyles-related flags work for all of the query subcommands.
Examples @@ -56,13 +51,24 @@ Query the ports.yml data source. With no arguments, all ports are displayed. purr query ``` +- List all ports excluding userstyles. + + ``` + purr query --no-userstyles + ``` + +- List all userstyles. + + ``` + purr query --only-userstyles + ``` + - Count the number of ports. ``` purr query --count ``` - - List the names of all ports. ``` @@ -146,8 +152,11 @@ purr query has [PROPERTIES] [-n | --not] [-c | --count] - `--name ` - `--category ` +- `--upstreamed` +- `--platform ` - `--icon ` - `--color ` +- `--alias` - `--url `
@@ -230,7 +239,7 @@ purr query whiskers [--is ] [-n | --not] [-c | --count | -p | --percentag Examples - Get the overall statistics of the Whiskerification process. - + ``` purr query whiskers ``` @@ -253,7 +262,7 @@ purr query whiskers [--is ] [-n | --not] [-c | --count | -p | --percentag purr query whiskers --is not-applicable ``` -- List repositories Whiskers *is* applicable for. +- List repositories Whiskers _is_ applicable for. ``` purr query whiskers --is not-applicable --not @@ -266,172 +275,15 @@ purr query whiskers [--is ] [-n | --not] [-c | --count | -p | --percentag The `init` command accepts each value (name, categories, etc.) via arguments, though if not provided a series of prompts will be displayed instead. ``` -purr init [PROPERTIES] -``` - -**Properties**: - -- `--name ` -- `--url ` - -### `userstyles` - -#### `query` - -``` -purr userstyles query [--for ] [-g | --get] [-c | --count] -``` - -Query the userstyles.yml data source. With no arguments, all userstyles are displayed. - -
-Examples - -- List all userstyles. - - ``` - purr userstyles query - ``` - -- Count the number of userstyles. - - ``` - purr userstyles query --count - ``` - - -- List the names of all userstyles. - - ``` - purr userstyles query --get name - ``` - -- List the current maintainers of the `youtube` userstyle. - - ``` - purr userstyles query --for youtube --get current-maintainers - ``` - -
- -##### `maintained` - -``` -purr userstyles query maintained [--by ] [-n | --not] [-c | --count] -``` - -
-Examples - -- List maintained userstyles. - - ``` - purr userstyles query maintained - ``` - -- Count the number of maintained userstyles. - - ``` - purr userstyles query maintained --count - ``` - -- List *un*maintained userstyles. - - ``` - purr userstyles query maintained --not - ``` - -- Count the number of *un*maintained userstyles. - - ``` - purr userstyles query maintained --not --count - ``` - -- List userstyles maintained by ``. - - ``` - purr userstyles query maintained --by "" - ``` - -- Count the number of userstyles maintained by ``. - - ``` - purr userstyles query maintained --by "" --count - ``` - -- List userstyles _not_ maintained by ``. - - ``` - purr userstyles query maintained --by "" --not - ``` - -- Count the number of userstyles _not_ maintained by ``. - - ``` - purr userstyles query maintained --by "" --not --count - ``` - -
- -##### `has` - -``` -purr userstyles query has [PROPERTIES] [-n | --not] [-c | --count] -``` - -**Properties:** - -- `--name ` -- `--category ` -- `--icon ` -- `--color ` -- `--app-link ` - -
-Examples - -- List userstyles with `color` set to `mauve`. - - ``` - purr userstyles query has --color mauve - ``` - -- Count the number of userstyles that have `color` set to `mauve`. - - ``` - purr userstyles query has --color mauve --count - ``` - -- Count the number of userstyles that have `color` set to anything other than `mauve`. - - ``` - purr userstyles query has --color mauve --not --count - ``` - -- List userstyles that do not have `icon` defined. - - ``` - purr userstyles query has --icon --not - ``` - -
- -#### `init` - -The `init` command accepts each value (name, categories, etc.) via arguments, though if not provided a series of prompts will be displayed instead. - -``` -purr userstyles init [PROPERTIES] +purr init