Mention INSTALL in README

[bzrirker.git] / __init__.py

diff --git a/__init__.py b/__init__.py
index 9bb0c566c210744c298182b57166bea3719a4324..bae47ea3e9e7b898d458a7ff20b761de3df4631b 100644 (file)
--- 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."""
@@ -50,8 +56,6 @@ option_registry.register_lazy("irker_channels",
     "bzrlib.plugins.bzrirker.irkerhook", "opt_irker_channels")
 option_registry.register_lazy("irker_colours",
     "bzrlib.plugins.bzrirker.irkerhook", "opt_irker_colours")
-option_registry.register_lazy("irker_url",
-    "bzrlib.plugins.bzrirker.irkerhook", "opt_irker_url")
 option_registry.register_lazy("irker_project",
     "bzrlib.plugins.bzrirker.irkerhook", "opt_irker_project")