v0.3 - Only refactoring, no new features; please note that this is still alpha-software

[friendica-addons.git] / piwik / README

diff --git a/piwik/README b/piwik/README
index eefd1cf96b876d5b11c714e77a7101980f759f90..c648a4d1214be6d4ea7563ad97ff511fef752afa 100755 (executable)
--- a/piwik/README
+++ b/piwik/README
@@ -1,27 +1,38 @@
-____ 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.
 
    tobias.diekershoff(at)gmx.net
 
 This addon allows you to embed the code necessary for the FLOSS webanalytics
 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.
 
 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 4 more configuration variables for the addon:
     $a->config['system']['addon'] = "piwik, ..."
 
 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']['baseurl'] = 'example.com/piwik/';
     $a->config['piwik']['sideid'] = '1';
     $a->config['piwik']['optout'] = true;