From 6f38fdfabfc0a71751ee0c5e4ab59fb45620d168 Mon Sep 17 00:00:00 2001 From: jbrule Date: Tue, 12 Feb 2019 11:35:20 -0600 Subject: [PATCH] Update README.md Readme formatting --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 042c9ff..2b097b4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # Matomo SiteAccessProvisioner Plugin -##Description +## Description Plugin for the Matomo Web Analytics software package that facilitates an easy process to grant users access to site reports. A companion access provider is required, usually in the form of a website CMS plugin/module (you may need to build this if one does not exist). -##Instructions +## Instructions The easiest way to install is to find the plugin in the [Matomo Marketplace](https://plugins.matomo.org/). A shared secret must be etablished before the plugin will function. You will then need to implement an access provider (see example code below) which will generate an access request link users can use. -##Usage +## Usage Implementation code for access provider. Should be trivial to port to other languages. ```php @@ -20,7 +20,7 @@ $token = hash('sha256', implode('',[$sharedSecret, $idUser, $site, $timestamp])) $linkHref = sprintf("http://matomoinstall.example.com/matomo/index.php?%s", http_build_query(["module"=>"SiteAccessProvisioner", "action"=>"accessRequest", "idUser"=>$idUser, "site"=>$site, "timestamp"=>$timestamp, "token"=>$token])); ``` -##License +## License GPL v3 / fair use ## Support