From 1c514f4c8a83d3f03642aa6c3dd78612097094a5 Mon Sep 17 00:00:00 2001
From: Natanael Copa <natanael.copa@gmail.com>
Date: Fri, 10 Sep 2010 13:04:13 +0200
Subject: readme: tell how to use sircbot-send

---
 README | 12 ++++++++++--
 1 file 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.
-- 
cgit v1.2.3