diff --git a/README.md b/README.md index 75c1e0fc..f1d2bbcb 100644 --- a/README.md +++ b/README.md @@ -253,19 +253,19 @@ option. ### Options | Short | Long | Description | |-------|-----------------|--------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | help. Use `jc -h --parser_name` for parser documentation | -| `-m` | `--monochrome` | monochrome output | -| `-p` | `--pretty` | pretty format the JSON output | -| `-q` | `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u` | `--unbuffer` | unbuffer output | -| `-v` | `--version` | version information | +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | Monochrome output | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | | `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | generate Bash shell completion script | -| `-Z` | `--zsh-comp` | generate Zsh shell completion script | +| `-B` | `--bash-comp` | Generate Bash shell completion script | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the diff --git a/templates/readme_template b/templates/readme_template index 9a65dd6f..36fefd2a 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -151,19 +151,19 @@ option. ### Options | Short | Long | Description | |-------|-----------------|--------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | help. Use `jc -h --parser_name` for parser documentation | -| `-m` | `--monochrome` | monochrome output | -| `-p` | `--pretty` | pretty format the JSON output | -| `-q` | `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-u` | `--unbuffer` | unbuffer output | -| `-v` | `--version` | version information | +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation | +| `-m` | `--monochrome` | Monochrome output | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | | `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | generate Bash shell completion script | -| `-Z` | `--zsh-comp` | generate Zsh shell completion script | +| `-B` | `--bash-comp` | Generate Bash shell completion script | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the