Fix name
[gitolite-hooks.git] / README.md
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..feeed2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+CTPUG gitolite hooks
+====================
+
+This repository is to track the various git hooks used by the CTPUG git infrastructure.
+
+These hooks are not automatically installed / deployed - that requires manual intervention
+on the actual server.
+
+Hooks
+-----
+
+### irker
+
+This handles posting commit messages to IRC via irker.
+
+### slack
+
+This handles posting commit messages to Slack using the slack webhook interface
+
+Scripts
+------
+
+### check-deploy
+
+This can be run on the server to report any outdated hooks.