summaryrefslogtreecommitdiff
path: root/plugins/Msn/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/Msn/README')
-rw-r--r--plugins/Msn/README32
1 files changed, 32 insertions, 0 deletions
diff --git a/plugins/Msn/README b/plugins/Msn/README
new file mode 100644
index 000000000..fa7bc2fb2
--- /dev/null
+++ b/plugins/Msn/README
@@ -0,0 +1,32 @@
+The MSN plugin allows users to send and receive notices over the MSN network.
+
+Required PHP extensions:
+curl pcre mhash mcrypt bcmath
+
+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' => '...'
+));
+