summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 10:31:25 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 10:31:25 +0000
commit14f323399c9652058a65970f37c334d6f6664951 (patch)
treec896330997503fc4a0b22ce70ba2702416e29eaa /README
parentInitial commit. (diff)
downloadirker-14f323399c9652058a65970f37c334d6f6664951.tar.xz
irker-14f323399c9652058a65970f37c334d6f6664951.zip
Adding upstream version 2.19+dfsg.upstream/2.19+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 24 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..7cd810b
--- /dev/null
+++ b/README
@@ -0,0 +1,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