Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Adding readme

  • Loading branch information...
commit befdb0718ec0891de56037dd6b0929dcfa8460a9 1 parent b59c223
Robert R Evans authored
Showing with 20 additions and 0 deletions.
  1. +20 −0 README.textile
View
20 README.textile
@@ -1 +1,21 @@
h1. Githooks
+
+Githooks is a gem that creates post-commit hooks for your application - if you are using git, of course. ;) Currently, it is just creating a post-commit hook to a campfire room of your choosing. That's all I need it for, for now.
+
+h2. How to Use
+
+Install the gem: sudo gem install revans-githooks
+
+Once installed, cd to the root of your project directory and do the following:
+
+githooks project_name --login your_campfire_login --pass campfire_password --domain campfire_subdmain --room "campfire room name"
+
+This is a pretty log command, so I'd suggest writing a bash script where you can put in the login, password, domain and room details and just pass the project name to githooks. Here is what I have in my ~/.bash_profile:
+
+function campfire_hook {
+ githooks $1 --login robo@facollective.com --pass password --domain facollective --room "War Room"
+}
+
+Then I can just do campfire_hook project_name.
+
+That's about it. I'm sure I'll be adding more to this as we have the need.
Please sign in to comment.
Something went wrong with that request. Please try again.