]> git.mxchange.org Git - quix0rs-gnu-social.git/commitdiff
Added README file
authorLuke Fitzgerald <lw.fitzgerald@googlemail.com>
Tue, 29 Jun 2010 17:57:48 +0000 (10:57 -0700)
committerLuke Fitzgerald <lw.fitzgerald@googlemail.com>
Tue, 29 Jun 2010 17:57:48 +0000 (10:57 -0700)
plugins/Msn/README [new file with mode: 0644]

diff --git a/plugins/Msn/README b/plugins/Msn/README
new file mode 100644 (file)
index 0000000..1c799a2
--- /dev/null
@@ -0,0 +1,29 @@
+The MSN plugin allows users to send and receive notices over the MSN network.
+
+Installation
+============
+add "addPlugin('msn',
+    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
+========
+user*: username (screenname) to use when logging into MSN
+password*: password for that user
+nickname*: nickname for the bot
+
+* required
+default values are in (parenthesis)
+
+Example
+=======
+addPlugin('msn', array(
+    'user' => '...',
+    'password' => '...',
+    'nickname' => '...'
+));
+