Update README for installation

2020-02-16 09:49:55 +00:00 · 2020-02-16 09:49:55 +00:00 · 451d503652
parent 82870d7bb8
commit 451d503652
1 changed files with 13 additions and 0 deletions
--- 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`.