summaryrefslogtreecommitdiffstats
path: root/README
blob: 7cd810b477ffc7477e23fcdbffd77ff6a7759373 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
	irker - submission tools for IRC notifications

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
repositories, allowing them to send commit notifications to project
IRC channels.  A hook script, irkerhook.py, supporting git, hg, and
Subversion is included in the distribution; see the install.txt file
for installation instructions.

The advantage of using this daemon over individual scripted sends 
is that it can maintain connection state for multiple channels,
avoiding obnoxious join/leave spam.

The file install.txt describes how to install the software safely, so
it can't be used as a spam conduit.

Please read the files security.txt and hacking.txt before modifying
this code.

						Eric S. Raymond
						September 2012