Add README

1 files changed, 10 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ff1a664
--- /dev/null
+++ b/README
@@ -0,0 +1,10 @@
+pre-commit: git pre commit hook to check syntax of puppet manifest, erb and
+	    ruby functions. Useful to check syntax when committing in your
+            local repo.
+update: git update hook to check syntax of puppet manifest, erb and ruby.
+        Useful to reject pushs with broken syntax on the server.
+
+To use the hooks copy (or symlink) it into your .git/hooks including the
+puppethooks/ dir. 
+
+Report bugs to Guido Günther <agx@sigxcpu.org>