added README

1 files changed, 11 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..eac2309
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+sircbot is a small IRC bot for use with git hooks, cronjobs, scripts etc
+
+It connects to server and joins given channels. When a channel is joined
+it creates a fifo: /var/run/sircbot/<#channel>
+
+Everything written to the fifo will be echoed in the 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.
+
+