aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README12
1 files changed, 10 insertions, 2 deletions
diff --git a/README b/README
index eac2309..fee9ba2 100644
--- a/README
+++ b/README
@@ -1,9 +1,17 @@
sircbot is a small IRC bot for use with git hooks, cronjobs, scripts etc
+start the server with:
+ sircbot -s SERVER -n NICK '#channel1' '#channel2'
+
It connects to server and joins given channels. When a channel is joined
-it creates a fifo: /var/run/sircbot/<#channel>
+it creates a unix socket /var/run/sircbot/<#channel> which can connected to
+with sircbot-send.
+
+To send to a connected channel use:
+
+ echo "$message" | sircbot-send '#channel1'
-Everything written to the fifo will be echoed in the channel.
+sircbot-send will send everything from stdin to given channel.
For every message that goes to the channel, sircbot will run all scripts in
/etc/sircbot.d/<#channel>/ with sender, message and channel name as arguments.