diff --git a/README.md b/README.md index 8831c4d..9ed0bbf 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,16 @@ Tests: - runs `go vet` on each module - runs `goimports` on all source (excluding generating protobuf `.pb.go` files) - checks for large (>1MiB) files + +## Installation + +You can install this commit globally by adding the following to your +`~/.gitconfig`: + +``` +[core] + hookspath = /home/username/git/hooks +``` + +and then copying the executable, named as `pre-commit`, to the directory you +named in `hookspath`.