@@ -14,8 +14,8 @@ curl -o /usr/local/bin/git-hooks https://raw.githubusercontent.com/slavcodev/git
14
14
chmod +x /usr/local/bin/git-hooks
15
15
~~~
16
16
17
- Run ` git hooks install ` in a git project to tell it to use ` git-hooks `
18
- and ` git hooks uninstall ` at any time to revert to your previous state.
17
+ Run ` git- hooks install ` in a git project to tell it to use ` git-hooks `
18
+ and ` git- hooks uninstall ` at any time to revert to your previous state.
19
19
_ (Check options of these commands to specify installation)._
20
20
21
21
## TL;DR
@@ -26,7 +26,7 @@ such as testing, code linting, etc, but Git is limited to only one script per ev
26
26
There is where ` git-hooks ` comes into play.
27
27
28
28
The ` git-hooks ` utilizes the Git configs only. On installation, it configures ` core.hooksPath `
29
- to tell Git to run ` git hooks trigger <hook-name> ` command.
29
+ to tell Git to run ` git- hooks trigger <hook-name> ` command.
30
30
31
31
On trigger the hooks, ` git-hooks ` looks in git configs for list of hooks needed to execute.
32
32
@@ -73,26 +73,21 @@ you have to add it config, i.e.
73
73
default = " .git/hooks"
74
74
~~~
75
75
76
- _A additional note on git sub-commands:
77
- When you type `git hooks` git actually looks for an executable called `git-hooks`.
78
- This is done automatically, so although we're invoking `git hooks` in the examples in this doc,
79
- you can also use `git-hooks` interchangeably._
80
-
81
76
# # Locations
82
77
83
78
The `git-hooks` respects the config location supported by `git-config`
84
79
([see more in documentation](https://git-scm.com/docs/git-config)).
85
80
86
81
Example how ot install `git-hooks` globally:
87
82
~~~bash
88
- git hooks install --global
83
+ git- hooks install --global
89
84
~~~
90
85
91
86
# # Documentation
92
87
93
88
For more details see `git-hooks` help:
94
89
~~~bash
95
- git hooks --help
90
+ git- hooks --help
96
91
~~~
97
92
98
93
# # Contributing
0 commit comments