diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..cebf749 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +sircbot +======= + +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 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' + +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. + + |