From fab6027a1b01664623cb1b2d594971528dececfc Mon Sep 17 00:00:00 2001 From: "Eric S. Raymond" Date: Thu, 27 Sep 2012 16:41:39 -0400 Subject: [PATCH] More documentation fixes. --- BUGS | 4 ++-- README | 15 +++++++-------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/BUGS b/BUGS index baf3169..44b5100 100644 --- a/BUGS +++ b/BUGS @@ -6,8 +6,8 @@ a replacement needed to be fielded immediately. * Testing has been minimal. -* There is one report of unexplainedly high CPU usage by the daemon when +* There is one report of unexplainedly high CPU usage by irkerd when processing UDP requests. * Despite what the header comment implies, the URL prefix and message template - can at present only be modified by hacking the script. + in irkerhook.py can at present only be modified by hacking the script. diff --git a/README b/README index 39a73d8..0794147 100644 --- a/README +++ b/README @@ -1,15 +1,14 @@ - 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 +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 supporting git and Subversion -is included. - -See the install.txt file for installation instructions. +IRC channels. A hook script, irkerhook.py, supporting git and +Subversion is included in the dustribution; see the install.txt file +for installation instructions. There's an alpha-stage proxy that takes CIA XML-RPC notofications and passes them to a local irker instance. Find it here: @@ -17,7 +16,7 @@ and passes them to a local irker instance. Find it here: https://github.com/nenolod/irker-cia-proxy Due to the abrupt death of cia.vc in late September 2012 the -inmitial release of this software was a bit rushed. See the file +initial release of this software was a bit rushed. See the file BUGS for known problems. Eric S. Raymond -- 2.26.2