Explain why relaying through this is a good idea!

diff --git a/README b/README
index c5a660390a7732718516d2a09e97f9c37f81db3e..661ae22fbe004ebe33b14ce2f83b2ef7699acc29 100644 (file)
--- a/README
+++ b/README
@@ -10,6 +10,10 @@ 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.
 
 Subversion is included in the distribution; see the install.txt file
 for installation instructions.
 

+The advantage of using this daeomon 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.
 
 Please read the files security.txt and hacking.txt before modifying
 this code.
 

diff --git a/irkerd.xml b/irkerd.xml
index bfbce36d31e5cb591dcf4498417bec6fa006f5e6..0638a6e5d62438c9893cc00eae343cd9f9902a1e 100644 (file)
--- a/irkerd.xml
+++ b/irkerd.xml
@@ -34,6 +34,11 @@ client intended to be used for shipping notification messages to IRC
 channels. The use case in mind when it was designed was broadcasting
 notifications from commit hooks in version-control systems.</para>
 
 channels. The use case in mind when it was designed was broadcasting
 notifications from commit hooks in version-control systems.</para>
 

+<para>The main advantage of relaying through this daemon over
+individual scripted sends from applications is that it can maintain
+connection state for multiple channels, rather than producing obnoxious
+join/leave channel spam on every message.</para>
+

 <para><application>irkerd</application> is a socket server that
 listens on for UDP or TCP packets on port 6659 for textual request
 lines containing JSON objects and terminated by a newline. Each JSON
 <para><application>irkerd</application> is a socket server that
 listens on for UDP or TCP packets on port 6659 for textual request
 lines containing JSON objects and terminated by a newline. Each JSON