c5a660390a7732718516d2a09e97f9c37f81db3e
[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 Please read the files security.txt and hacking.txt before modifying
14 this code.
15
16                                                 Eric S. Raymond
17                                                 September 2012