Skip to content

Commit 4cee3b5

Browse files
committed
docs(README.md): Fixes 'usage' description
1 parent 089674e commit 4cee3b5

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,18 @@ To install, simply clone this repo.
1313

1414
# Usage:
1515
```
16-
bash linus_commit_helper.sh --<install|commit> <project_path>
17-
bash linus_commit_helper.sh --<uninstall|help>
16+
bash linus_commit_helper.sh --<install|uninstall|commit> <project_path>
17+
bash linus_commit_helper.sh --help
18+
19+
This is only used internally in the hook and can be ignored:
20+
bash linus_commit_helper.sh --hook <COMMIT_MSG_FILE> <COMMIT_SOURCE> <SHA1>
1821
1922
Options:
2023
--install Installs this script as a git hook into the provided git project
21-
--uninstall Prints instructions to uninstall this script (its just 2 simple steps)
22-
--commit Runs this program in standalone-mode. Request commit message
23-
and then commits automatically
24+
--uninstall Prints instructions to uninstall this script and optionally opens the hook file in the default editor
25+
--commit Runs this program in standalone-mode. Request commit message and then commits automatically
2426
--hook Is used internally when called via git hook
25-
--help Prints this help info
27+
--help Prints additional help\n"
2628
```
2729

2830
To use it on its own, call this program with the path to the repo e.g.

0 commit comments

Comments
 (0)