From: Luke Fitzgerald <lw.fitzgerald@googlemail.com>
Date: Sun, 4 Jul 2010 17:24:22 +0000 (-0700)
Subject: Added README
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=3dce582182b59e00c0932ce99d47e76bdf99ac64;p=quix0rs-gnu-social.git

Added README
---

diff --git a/plugins/Irc/README b/plugins/Irc/README
new file mode 100644
index 0000000000..f3d1897779
--- /dev/null
+++ b/plugins/Irc/README
@@ -0,0 +1,35 @@
+The IRC plugin allows users to send and receive notices over an IRC network.
+
+Installation
+============
+add "addPlugin('irc',
+    array('setting'=>'value', 'setting2'=>'value2', ...);"
+to the bottom of your config.php
+
+scripts/imdaemon.php included with StatusNet must be running. It will be started by
+the plugin along with their other daemons when you run scripts/startdaemons.sh.
+See the StatusNet README for more about queuing and daemons.
+
+Settings
+========
+host*: => Hostname of IRC server
+port*: => Port of IRC server
+username*: => Username of bot
+realname*: => Real name of bot
+nick*: => Nickname of bot
+password: Password
+transport: Set to 'ssl' to enable SSL
+encoding: Set to UTF8 to enable UTF8 encoding
+
+* required
+
+Example
+=======
+addPlugin('irc', array(
+    'host' => '...',
+    'port' => '...',
+    'username' => '...',
+    'realname' => '...',
+    'nick' => '...'
+));
+