More documentation fixes.
[irker.git] / README
1         irker - submission tools for IRC notifications
2
3 irkerd is a specialized IRC client that runs as a daemon, allowing 
4 other programs to ship IRC notifications by sending JSON objects to a 
5 listening socket. 
6
7 It is meant to be used by hook scripts in version-control
8 repositories, allowing them to send commit notifications to project
9 IRC channels.  A hook script, irkerhook.py, supporting git and
10 Subversion is included in the dustribution; see the install.txt file
11 for installation instructions.
12
13 There's an alpha-stage proxy that takes CIA XML-RPC notofications 
14 and passes them to a local irker instance. Find it here:
15
16     https://github.com/nenolod/irker-cia-proxy
17
18 Due to the abrupt death of cia.vc in late September 2012 the
19 initial release of this software was a bit rushed.  See the file
20 BUGS for known problems.
21
22                                                 Eric S. Raymond
23                                                 August 2012