From e9ccdd28ef38dbf85263cd9664322f6120a91e95 Mon Sep 17 00:00:00 2001
From: varac <varacanero@zeromail.org>
Date: Tue, 17 Mar 2015 15:41:42 +0100
Subject: [PATCH] updated README.md with installation section

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index d0c7fed..3896854 100644
--- a/README.md
+++ b/README.md
@@ -19,3 +19,19 @@ Current supported pre-receive (server side) checks
 * Erb template syntax
 * Puppet-lint
 * Yaml (hiera data) syntax
+
+Installation
+============
+
+Clone this repository
+
+    git clone https://github.com/pixelated-project/puppet-git-hooks.git
+
+Go in the git hooks directory of you puppet git repository
+
+    cd <PATH_TO_YOUR_PUPPET_REPO>/.git/hooks
+
+Create symlinks to the `pre-commit` file and the `commit_hooks` directory
+
+    ln -s <PATH_TO_PUPPET-GIT-HOOKS_REPO>/pre-commit
+    ln -s <PATH_TO_PUPPET-GIT-HOOKS_REPO>/commit_hooks