From: Neil <neil@dip.sun.ac.za>
Date: Sat, 17 Nov 2012 15:37:56 +0000 (+0200)
Subject: Add more useful help test
X-Git-Url: https://git.ctpug.org.za/?a=commitdiff_plain;h=518147bcd82c81e31bd7e83a669a16c9dc520cc6;p=bzrirker.git

Add more useful help test
---

diff --git a/__init__.py b/__init__.py
index 26d45a2..bae47ea 100644
--- a/__init__.py
+++ b/__init__.py
@@ -4,7 +4,14 @@
 # GPL 2+ - see COPYING for details
 """Sending irker notifications for commits and branch changes.
 
-Details to follow
+This will talk to an irkerd (currently assumed to be running on localhost)
+and post commit logs.
+
+Useful configuration settings:
+    irker_project - The name of the project used in announcements
+    irker_channels - The irc channels to post announcements to
+    irker_colours - Settings for using colours in the announcements (ANSI or
+        mIRC)
 """
 
 from bzrlib.config import option_registry
@@ -17,7 +24,6 @@ from bzrlib.plugins.bzrirker import irkerhook as _irkerhook
 """)
 
 
-
 def branch_commit_hook(local, master, old_revno, old_revid,
         new_revno, new_revid):
     """This is the post_commit hook that runs after commit."""