Add support for Kirby 3.6

Author: PaulMorel

CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - 2021-10-21
+
+### Added
+
+- Support for Kirby v3.6
+- `disableForRole` option that disables the tracking code snippet for specific user roles. Defaults to `[ 'admin' ]`
+- Tested support for lowest working Kirby 3 version and added badge at the top of readme file
+
+### Fixed
+
+- Loading icon not spinning while Fathom Analytics iframe is loading
+- Missing translation in dropdown menu
+
+### Changed
+
+- French translations from *Métriques* to *Statistiques*
+
+
 ## [0.0.2] - 2021-09-30
 
 ### Fixed
@@ -17,5 +35,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Panel view to display the Fathom Analytics dashboard directily in the panel
 - Snippet to embed the Fathom Analytics tracking code 
 
+[1.0.0]: https://github.com/PaulMorel/kirby3-fathom-analytics/releases/tag/v1.0.0
 [0.0.2]: https://github.com/PaulMorel/kirby3-fathom-analytics/releases/tag/v0.0.2
 [0.0.1]: https://github.com/PaulMorel/kirby3-fathom-analytics/releases/tag/v0.0.1

README.md

@@ -1,6 +1,9 @@
 # Kirby Fathom Analytics
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/paulmorel/kirby3-fathom-analytics)
+![Kirby CMS Version](https://img.shields.io/badge/Kirby-v3.4.0+-informational)
+![License](https://img.shields.io/github/license/paulmorel/kirby3-fathom-analytics)
 
-A Kirby 3 plugin for integrating the [Fathom Analytics](https://usefathom.com/) service to your site.
+A Kirby 3 plugin for integrating the privacy focused [Fathom Analytics](https://usefathom.com/) service to your site.
 
 ## Main Feautres
 
@@ -10,7 +13,7 @@ This plugin does two things:
 - It provides a snippet to embed the Fathom Analytics tracking code 
 
 ## Requirements
-- Kirby CMS v3.5
+- Kirby CMS v3.4.0+
 
 
 ## Installation
@@ -78,6 +81,11 @@ If no `siteId` is provided, the snippet does nothing.
 </head>
 ```
 
+### Viewing your stats
+
+The plugin provides a panel view that loads your site's analytics dashboard in an iframe. Simply open the menu in the panel's top bar and click on Analytics.
+
+
 ## Options
 
 ### `siteId` (Required)
@@ -98,6 +106,23 @@ Example:
 'customDomain' => 'https://armadillo.example.com'
 ```
 
+### `disableForRole`
+
+Allows you to disable the tracking code for logged in users with the specified roles. Expects an `Array`. Defaults to `['admin']`.
+
+Examples:
+```php
+'disableForRole' => [
+    'admin'
+],
+```
+```php
+'disableForRole' => [
+    'admin',
+    'editor',
+    'translator'
+],
+```
 ## Disclaimer
 
 This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "paulmorel/fathom-analytics",
-    "version": "0.0.2",
+    "version": "1.0.0",
     "description": "A Kirby 3 plugin for integrating the Fathom Analytics service to your site.",
     "type": "kirby-plugin",
     "license": "MIT",