Skip to content

Commit 6ade3bd

Browse files
committed
docs: Update help example text
CHanges formatting to `text` to handle some odd syntax highlighting
1 parent 8e4cafe commit 6ade3bd

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ It's also the [oxidation](https://wiki.mozilla.org/Oxidation) of an existing [CL
44

55
### Documentation
66

7-
```bash
7+
```text
88
A CLI to validate and generate Github's CODEOWNERS file
99
10-
Usage: codeowners [OPTIONS] <COMMAND>
10+
Usage: codeowners-rs [OPTIONS] <COMMAND>
1111
1212
Commands:
13-
generate Generate the CODEOWNERS file and save it to '--codeowners-file-path'
14-
validate Validate the validity of the CODEOWNERS file. A validation failure will exit with a failure code and a detailed output of the validation errors
15-
generate-and-validate Chains both 'generate' and 'validate' commands
16-
for-file Print the owners for a given file
13+
for-file Finds the owner of a given file. [aliases: f]
14+
for-team Finds code ownership information for a given team [aliases: t]
15+
generate Generate the CODEOWNERS file and save it to '--codeowners-file-path'. [aliases: g]
16+
validate Validate the validity of the CODEOWNERS file. A validation failure will exit with a failure code and a detailed output of the validation errors. [aliases: v]
17+
generate-and-validate Chains both `generate` and `validate` commands. [aliases: gv]
1718
help Print this message or the help of the given subcommand(s)
1819
1920
Options:

0 commit comments

Comments
 (0)