diff --git a/.hooks/README.md b/.hooks/README.md index 5a76030..c798795 100644 --- a/.hooks/README.md +++ b/.hooks/README.md @@ -1,7 +1,8 @@ -This folder contains git hooks which will be executed on the client side before certain git actions are completed. +This folder contains git hook scripts which will be executed on the client side before/after certain git actions are completed. ## Usage -On each local system these files must be symlinked into `repo/.git/hooks` directory. +To install these hooks, create a symlink to `/path/to/repo/.git/hooks` directory. + ```bash ln -s "$(git rev-parse --show-toplevel)/.hooks/pre-commit.sh" "$(git rev-parse --show-toplevel)/.git/hooks/pre-commit"