From: Tobias Diekershoff <tobias.diekershoff@gmx.net>
Date: Sat, 1 Jun 2013 15:30:44 +0000 (+0200)
Subject: mardownification of the README
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=62949af91e2423e0494613917f1710dc7300c927;p=friendica-addons.git

mardownification of the README
---

diff --git a/piwik/README b/piwik/README
deleted file mode 100755
index c648a4d1..00000000
--- a/piwik/README
+++ /dev/null
@@ -1,57 +0,0 @@
-## 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.
-
-[Online version of this Document](http://ur1.ca/35m2x)
-
-### Requirements ###
-
-To use this plugin you need a [piwik](http://piwik.org/) installation.
-
-### Where to find ###
-
-In the Friendica git repository `/addon/piwik/piwik.php` and a CSS file for
-styling the opt-out notice.
-
-### 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.
-
-    $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']['async'] = false;
-
-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
-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.
-
-Currently the optional notice states the following:
-
-    This website is tracked using the Piwik analytics tool. If you do not want
-    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.
diff --git a/piwik/README.md b/piwik/README.md
new file mode 100755
index 00000000..1005970b
--- /dev/null
+++ b/piwik/README.md
@@ -0,0 +1,61 @@
+Piwik Plugin
+============
+
+by Tobias Diekershoff 
+
+This addon allows you to embed the code necessary for the FLOSS webanalytics
+tool Piwik into the Friendica pages.
+
+Requirements
+------------
+
+To use this plugin you need a [piwik](http://piwik.org/) installation.
+
+Where to find
+-------------
+
+In the Friendica addon git repository `/piwik/piwik.php` and a CSS file for
+styling the opt-out notice.
+
+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.
+
+    $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']['async'] = false;
+
+Configuration fields
+---------------------
+
+* 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
+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.
+* The *async* parameter (true|false) defines whether or not to use asynchronous
+tracking so pages load (or appear to load) faster.
+
+Currently the optional notice states the following:
+
+>    This website is tracked using the Piwik analytics tool. If you do not want
+>    that your visits are logged this way you can set a cookie to prevent Piwik
+>    from tracking further visits of the site (opt-out).
+