]> gitweb.fluxo.info Git - git-hooks.git/commitdiff
Add a section to the README describing how to create hooks
authorBenjamin C Meyer <ben@meyerhome.net>
Wed, 17 Mar 2010 05:05:56 +0000 (01:05 -0400)
committerBenjamin C Meyer <ben@meyerhome.net>
Wed, 17 Mar 2010 06:18:38 +0000 (02:18 -0400)
Signed-off-by: Benjamin C Meyer <ben@meyerhome.net>
README

diff --git a/README b/README
index 2190287b712446414b9953fef0e7c63a9281cb1c..beb27376d1999bcce18b8ae30547c4f81d003e0d 100644 (file)
--- a/README
+++ b/README
@@ -23,6 +23,15 @@ git-hooks provide a way to manage and share your hooks by allowing for the insta
 When GLOBAL_GIT_HOOKS is not set it defaults to the git-hooks /contrib/ folder.
 Multiple global hooks directories can be specified by using a space between them.
 
+
+--- Creating hooks
+
+To keep things organized git-hooks looks for scripts in sub directories named after the git hook name.  For example this project has the following pre-commit script in the following location:
+
+git_hooks/pre-commit/bsd
+
+When you run 'git hooks' with no arguments it will list all of the hooks installed on the system.  It will run the hooks with the --about argument to generate the description that is shown.
+
 -- Install
 
 Clone the git-hooks repository and add it to your path.