Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Better readme

  • Loading branch information...
commit 0456e03b1a647b2ee1e0706b0b57306afc9df11c 1 parent 4a45ff0
@1stvamp authored
Showing with 19 additions and 1 deletion.
  1. +19 −1 README.rst
View
20 README.rst
@@ -14,6 +14,24 @@ Using `buildout`::
bin/django syncdb
bin/django runserver
+Just from source::
+
+ git clone git://github.com/1stvamp/gh-hooky.git
+ cd gh-spooky
+ # You might want to put this in a virtualenv
+ pip install -E --requirement ./requirements.txt
+ cd src/hooky
+ cp settings.py.example settings.py
+ # Edit settings with your DB info etc.
+ ./manage.py syncdb
+ ./manage.py runserver
+
Usage
=====
-lorem ipsum dolar set ...
+Setup, get it running from a publically accessable address, and then login to ``hooky`` using whatever account details you've created.
+
+When you've logged in, you can enter your Github username and API key, as well as a secret key for the post_commit hook calls from Github, I'd suggest running something like::
+
+ $ dd if=/dev/urandom count=1 | tr -cd 'A-Za-z0-9' | cut -c1-30; echo
+
+When you've saved your details you'll be given a commit hook URL you can put into the '''Post Receive URLs''' section of your repository admin '''Service Hooks''' section.
Please sign in to comment.
Something went wrong with that request. Please try again.