merge with upstream
[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, hg, and
10 Subversion is included in the distribution; see the install.txt file
11 for installation instructions.
12
13 There's an alpha-stage proxy that takes CIA XML-RPC notifications 
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 on September 24 2012 the
19 initial release of this software was a bit rushed.  See the file
20 BUGS for known problems.
21
22 Please read the files security.txt and hacking.txt before modifying this code.
23
24                                                 Eric S. Raymond
25                                                 August 2012