summaryrefslogtreecommitdiff
path: root/plugins/Aim/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/Aim/README')
-rw-r--r--plugins/Aim/README27
1 files changed, 27 insertions, 0 deletions
diff --git a/plugins/Aim/README b/plugins/Aim/README
new file mode 100644
index 000000000..046591738
--- /dev/null
+++ b/plugins/Aim/README
@@ -0,0 +1,27 @@
+The AIM plugin allows users to send and receive notices over the AIM network.
+
+Installation
+============
+add "addPlugin('aim',
+ array('setting'=>'value', 'setting2'=>'value2', ...);"
+to the bottom of your config.php
+
+The daemon included with this plugin 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 AIM
+password*: password for that user
+
+* required
+default values are in (parenthesis)
+
+Example
+=======
+addPlugin('aim', array(
+ 'user=>'...',
+ 'password'=>'...'
+));
+