Update README. Add check-deploy script and placeholder post-receive

[gitolite-hooks.git] / README.md

diff --git a/README.md b/README.md
index feeed2fa83e24e5c10cf1c8e660335da8af5c954..387a507acc62e9e1be80912d3a6bcc42093dbc33 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,6 +3,9 @@ CTPUG gitolite hooks
 
 This repository is to track the various git hooks used by the CTPUG git infrastructure.
 
+We don't use the gitolite hooks via admin option, because it requires a less standard
+config.
+
 These hooks are not automatically installed / deployed - that requires manual intervention
 on the actual server.
 
@@ -17,9 +20,16 @@ This handles posting commit messages to IRC via irker.
 
 This handles posting commit messages to Slack using the slack webhook interface
 
+### post-receive
+
+This is the global post-receive hook that dispatches messages to the appropriate
+notifiers if the config option is specified.
+
 Scripts
 ------
 
 ### check-deploy
 
 This can be run on the server to report any outdated hooks.
+
+check-deploy asumes that the hooks repo is checked out on the server to ~/local/gitolite-hooks