Merge branch 'merge-requests/32'
[irker: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 The advantage of using this daemon over individual scripted sends 
14 is that it can maintain connection state for multiple channels,
15 avoiding obnoxious join/leave spam.
16
17 Please read the files security.txt and hacking.txt before modifying
18 this code.
19
20                                                 Eric S. Raymond
21                                                 September 2012