Added README file

This commit is contained in:
Luke Fitzgerald 2010-06-29 10:57:48 -07:00
parent 6aa8ce08ae
commit 2e8a4e3a0f
1 changed files with 29 additions and 0 deletions

29
plugins/Msn/README Normal file
View File

@ -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' => '...'
));