Merge remote-tracking branch 'upstream/master'

[friendica-addons.git] / piwik / README

diff --git a/piwik/README b/piwik/README
index d5060d0b0e7d73171d8154fb5153e37c90cfd504..c648a4d1214be6d4ea7563ad97ff511fef752afa 100755 (executable)
--- a/piwik/README
+++ b/piwik/README
@@ -1,36 +1,48 @@
-____ Piwik Plugin ____
-by Tobias Diekershoff
+## Piwik Plugin ##
+
+by Tobias Diekershoff 
+   http://diekershoff.homeunix.net/friendika/profile/tobias
    tobias.diekershoff(at)gmx.net
 
 This addon allows you to embed the code necessary for the FLOSS webanalytics
-tool piwik into the Friendica pages.
+tool Piwik into the Friendica pages.
 
-Online version of this Document: http://ur1.ca/35m2x
+[Online version of this Document](http://ur1.ca/35m2x)
 
-___ Requirements ___
+### Requirements ###
 
-To use this plugin you need a "piwik":http://piwik.org installation.
+To use this plugin you need a [piwik](http://piwik.org/) installation.
 
-___ Where to find ___
+### Where to find ###
 
-In the Friendica git repository @/addon/piwik/piwik.php@ and a CSS file for
+In the Friendica git repository `/addon/piwik/piwik.php` and a CSS file for
 styling the opt-out notice.
 
-___ Configuration ___
+### Configuration ###
+
+The easiest way to configure this addon is by activating the admin panels of
+your ~friendica server and then enter the needed details on the config page
+for the addon.
+
+If you don't want to use the admin panel, you can configure the addon through
+the .htconfig file.
+
+Open the .htconfig.php file and add "piwik" to the list of activated addons.
 
-Open the .htconfig.php file and add "piwik" to the list of activated addons. 
     $a->config['system']['addon'] = "piwik, ..."
-You have to add 3 more configuration variables for the addon:
 
-$a->config['piwik']['baseurl'] = 'example.com/piwik/';
-$a->config['piwik']['sideid'] = '1';
-$a->config['piwik']['optout'] = true;
+You have to add 4 more configuration variables for the addon:
+
+    $a->config['piwik']['baseurl'] = 'example.com/piwik/';
+    $a->config['piwik']['sideid'] = '1';
+    $a->config['piwik']['optout'] = true;
+    $a->config['piwik']['async'] = false;
 
-The *baseurl* points to your piwik installation. Use the absolute path,
+The *baseurl* points to your Piwik installation. Use the absolute path,
 remember trailing slashes but ignore the protocol (http/s) part of the URL.
 Change the *sideid* parameter to whatever ID you want to use for tracking your
 Friendica installation. The *optout* parameter (true|false) defines whether or
-not a short notice about the utilization of piwik will be displayed on every
+not a short notice about the utilization of Piwik will be displayed on every
 page of your Friendica site (at the bottom of the page with some spacing to the
 other content). Part of the note is a link that allows the visitor to set an
 _opt-out_ cookie which will prevent visits from that user be tracked by piwik.
@@ -41,3 +53,5 @@ Currently the optional notice states the following:
     that your visits are logged this way you can set a cookie to prevent Piwik
     from tracking further visits of the site (opt-out).
 
+The *async* parameter (true|false) defines whether or not to use asynchronous
+tracking so pages load (or appear to load) faster.