Skip to content

Commit 13a1bad

Browse files
authored
Merge pull request #122 from thibaudcolas/patch-1
simplify --help example in README
2 parents 84b09cc + 4184239 commit 13a1bad

File tree

1 file changed

+3
-27
lines changed

1 file changed

+3
-27
lines changed

README.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,36 +16,12 @@ Scripts for creating mirror repositories that do not have
1616

1717
### Sample Usage
1818

19-
```
20-
$ pre-commit-mirror --help
21-
usage: pre-commit-mirror [-h] --language {node,python,ruby,rust}
22-
--package-name PACKAGE_NAME
23-
(--files-regex FILES_REGEX | --types TYPES)
24-
[--entry ENTRY] [--args ARGS]
25-
repo_path
26-
27-
positional arguments:
28-
repo_path Local path where the git repo is checked out.
19+
To see all supported configuration options, run:
2920

30-
optional arguments:
31-
-h, --help show this help message and exit
32-
--language {node,python,ruby,rust}
33-
Which language to use.
34-
--package-name PACKAGE_NAME
35-
Package name as it appears on the remote package
36-
manager.
37-
--files-regex FILES_REGEX
38-
Files regex to use in hooks.yaml
39-
--types TYPES `identify` type to match
40-
--id ID Hook id, defaults to the entry point.
41-
--entry ENTRY Entry point, defaults to the package name.
42-
--args ARGS Comma separated arguments for the hook. Escape commas
43-
in args with a backslash (\). For example: --args='-i,
44-
--ignore=E265\,E501' would give you [-i,
45-
--ignore=E265,E501]
21+
```console
22+
$ pre-commit-mirror --help
4623
```
4724

48-
4925
For example: making a mirror of the yapf package:
5026

5127
```console

0 commit comments

Comments
 (0)