From afacf1b156a728ac6e77619091c6c109157b0a31 Mon Sep 17 00:00:00 2001
From: Martin Thielecke <github@mthie.com>
Date: Sat, 1 Aug 2015 00:34:19 +0000
Subject: [PATCH] readme

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a68822f..670156a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
-# git-gohooks
+git-hooks
+=========
+
+Collection of git hooks. Most of the pre-commit hooks are Go specific.
+
+
+usage
+-----
+
+* to install the hooks use:
+		go get github.com/mthie/git-gohooks
+		go get github.com/mthie/git-gohooks/githook-gobuild
+		go get github.com/mthie/git-gohooks/githook-gofmt
+		go get github.com/mthie/git-gohooks/githook-gotest
+		
+  you have the choice to copy it to your .git/hooks/ folder or to symlink
+  it with
+		( cd .git/hooks && ln -s $GOPATH/bin/git-gohooks pre-commit && ln -s $GOPATH/bin/githook-gofmt pre-commit_01_gofmt && ln -s $GOPATH/bin/githook-gobuild pre-commit-02_gobuild && ln -s $GOPATH/bin/githook-gotest pre-commit_03_gotest )
+