From 73c8733e1463997f1297772a2dc0264b5c7d03f8 Mon Sep 17 00:00:00 2001 From: "Eric S. Raymond" Date: Tue, 26 Nov 2013 05:53:28 -0500 Subject: [PATCH] Explain why relaying through this is a good idea! --- README | 4 ++++ irkerd.xml | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/README b/README index c5a6603..661ae22 100644 --- 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. +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. diff --git a/irkerd.xml b/irkerd.xml index bfbce36..0638a6e 100644 --- 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. +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. + irkerd 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 -- 2.26.2