]> git.mxchange.org Git - friendica-addons.git/commitdiff
SN/Twitter relay updated the README file
authorTobias Diekershoff <tobias.diekershoff@gmx.net>
Fri, 6 Apr 2012 08:35:29 +0000 (10:35 +0200)
committerTobias Diekershoff <tobias.diekershoff@gmx.net>
Fri, 6 Apr 2012 08:35:29 +0000 (10:35 +0200)
statusnet/README
twitter/README

index 32c11c7e99119af08f384283d97362619c0865fb..f172f2ce659c2cf80280f726550e52cc7defc1d0 100755 (executable)
@@ -42,12 +42,35 @@ ___ Configuration ___
 
 __ Global Configuration __
 
-If you enabled an administrator account, please use the admin panel to cofigure
-the StatusNet relay.
-
-To activate this addon add statusnet to the list of active addons in your
-.htconfig.php file 
-    $a->config['system']['addon'] = "statusnet, ...".
+If you have configured an admin account, you can configure this plugin from
+the admin panel. First activate it from the plugin section of the panel.
+Afterwards you will have a separate configuration page for the plugin, where
+you can provide a set of globally available OAuth credentials for different
+StatusNet pages which will be available for all users of your server.
+
+If you don't use the admin panel, you can configure the relay using the
+.htconfig.php file of your friendica installation. To activate the relay add
+it's name to the list of activated addons.
+
+ $a->config['system']['addon'] = "statusnet, ..."
+
+If you want to provide preconfigured StatusNet instances for your user add the
+credentials for them by adding
+
+$a->config['statusnet']['sites'] = array (
+   array ('sitename' => 'identi.ca', 'apiurl' => 'https://identi.ca/api/',
+     'consumersecret' => 'OAuth Consumer Secret here', 'consumerkey' => 'OAuth
+     Consumer Key here'),
+   array ('sitename' => 'Some other Server', 'apiurl' =>
+     'http://status.example.com/api/', 'consumersecret'  => 'OAuth
+     Consumer Secret here', 'consumerkey' => 'OAuth Consumer Key here')
+);
+
+to the config file.
+
+Regardless of providing global OAuth credentials for your users or not, they
+can always add their own OAuth-Key and -Secret thus enable the relay for any
+StatusNet instance they may have an account at.
 
 __ User Configuration __
 
index 3b8f0e85046ba1bf8a16d7f5d88972677b36363b..56dbc7e29053084b46e81cd15087cb853a2d45e8 100755 (executable)
@@ -47,8 +47,8 @@ ___ Configuration ___
 
 __ Global Configuration __
 
-If you enabled an administrator account, please use the admin panel to cofigure
-the Twitter relay.  If you for any reason prefer to use a configuration file instead 
+If you enabled an administrator account, please use the admin panel to configure
+the Twitter relay. If you for any reason prefer to use a configuration file instead 
 of the admin panels, please refer to the Alternative Configuration below. 
 
 Activate the plugin from the plugins section of your admin panel.  When you have
@@ -56,12 +56,12 @@ done so, add your consumer key and consumer secret in the settings section of th
 plugin page.
 
 When this is done your user can now configure their Twitter connection at
-"Settings -> Plugin Settings" and enable the forwarding of their *public*
+"Settings -> Connector Settings" and enable the forwarding of their *public*
 messages to Twitter.
 
 __ Alternative Configuration __
 
--To activate this addon add @twitter@ to the list of active addons in your
+To activate this addon add @twitter@ to the list of active addons in your
 .htconfig.php file 
 
 $a->config['system']['addon'] = "twitter, ..."