irkerd: Split imported modules onto their own lines

[irker.git] / README

diff --git a/README b/README
index 4df5369ef8cf70e1a2da4725c2c5a6b985a08930..f47778b9c85566c42d9f7058720bd17155197c57 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,21 @@
-       irker - submission tool for IRC notifications
+       irker - submission tools for IRC notifications
 
-irker is a specialized IRC client that runs as a daemon, allowing 
+irkerd is a specialized IRC client that runs as a daemon, allowing 
 other programs to ship IRC notifications by sending JSON objects to a 
-listening socket. It is meant to be used by hook scripts in version-
-control repositories, allowing them to send commit notifications
-to project IRC channels.
+listening socket. 
+
+It is meant to be used by hook scripts in version-control
+repositories, allowing them to send commit notifications to project
+IRC channels.  A hook script, irkerhook.py, supporting git, hg, and
+Subversion is included in the distribution; see the install.txt file
+for installation instructions.
+
+The advantage of using this daemon over individual scripted sends 
+is that it can maintain connection state for multiple channels,
+avoiding obnoxious join/leave spam.
+
+Please read the files security.txt and hacking.txt before modifying
+this code.
 
                                                Eric S. Raymond
-                                               August 2012
+                                               September 2012