From 840ba801317655d23a12dae340f97bc655b2a77d Mon Sep 17 00:00:00 2001 From: Luke Watts Date: Mon, 29 Jul 2024 14:36:59 +0200 Subject: [PATCH] docs: update setup steps * Address a few typos * Update configuration example * Restructure how to use as single ordered list --- readme.md | 42 ++++++++++++++++++++---------------------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/readme.md b/readme.md index 81fb31c..b2a61e5 100644 --- a/readme.md +++ b/readme.md @@ -1,32 +1,30 @@ # Kirby Plausible -Simple plugin providing plausible iframe panel view to kirby panel and simple frontend snippet. +Simple plugin providing Plausible iframe panel view to Kirby panel and frontend snippet. ![CleanShot 2021-11-04 at 17 53 43](https://user-images.githubusercontent.com/4954323/140384031-efdf83d7-06a3-4ce3-a60b-3827fe63fd9c.png) -## Instalation +## Installation `composer require floriankarsten/kirby-plausible` or download from releases ## How to use 1. Create a shared link https://plausible.io/docs/shared-links -2. Set `floriankarsten.plausible.sharedLink` in config.php - -There is also `floriankarsten.plausible.domain` which allows you to overwrite `data-domain` in the frontend snippet. - -`config.php` example -```php -'floriankarsten.plausible' => [ - 'sharedLink' => 'https://plausible.io/share/yourwebsiteurl.com?auth=Jz0mCWTPu5opXi0sAgRrq', - 'domain' => 'test.com', // not required if not set it will be taken from $site->url - // To use a self-hosted Plausible instance - //'scriptHost' => 'https://plausible.example.com', - // To use Plausible script extensions - //'scriptName' => 'plausible.outbound-links.exclusions' -]; -``` - -Frontend snippet place iside head tag. Automatically disabled when kirby is in debug mode. -```php - -``` +1. Set `floriankarsten.plausible.sharedLink` in config.php + ```php + // config/config.php + 'floriankarsten.plausible' => [ + // Required + 'sharedLink' => 'https://plausible.io/share/yourwebsiteurl.com?auth=Jz0mCWTPu5opXi0sAgRrq', + // Optional: The value that will be set in data-domain attribute of