Adding widget, bumping to 1.1

Author: jackabox

README.md

@@ -6,14 +6,8 @@ A wrapper around the Plausible API that fetches the analytics into your dashboar
 
 Install the addon.
 
-```bash
-composer require jackabox/statamic-plausible-analytics
 ```
-
-Publish the assets
-
-```bash
-php artisan vendor:publish --provider="Jackabox\Plausible\PlausibleServiceProvider"
+composer require jackabox/statamic-plausible-analytics
 ```
 
 Then follow the steps in the config step bellow.
@@ -23,9 +17,8 @@ Then follow the steps in the config step bellow.
 1. Head to your [Plausible Settings](https://plausible.io/settings).
 2. Scroll down to API key and generate a new one. Name it whatever you like.
 3. Copy that value into your `.env` as `PLAUSIBLE_KEY`.
-4. If you're self hosting Plausible, add the config option for `PLAUSIBLE_DOMAIN` in your `.env`
-5. Get your site as displayed in your Plausible Dashboard (e.g. jackwhiting.co.uk). Add that value to your `.env` as `PLAUSIBLE_SITE`.
-6. Data should load.
+4. Get your site as displayed in your Plausible Dashboard (e.g. jackwhiting.co.uk). Add that value to your `.env` as `PLAUSIBLE_SITE`.
+5. Data should load.
 
 For more customisation you can publish the config and adjust the values as you wish.
 
@@ -35,6 +28,47 @@ php artisan vendor:publish --tag=plausible-config
 
 By default, all results from the API are cached. This can be overwritten, but I didn't want to spam to the API.
 
+## Widgets
+
+There are four widgets included with a few options. Periods to display be changed between `12mo,6mo,month,30d,6d,day`.
+
+### Visitor Overview
+
+```php
+[
+    'type' => 'plausible_visitor_overview',
+    'period' => '30d', // Period you want to show
+    'show_graph' => 0 // Boolean, 0 or 1
+],
+```
+
+### Top Pages
+
+```php
+[
+    'type' => 'plausible_top_pages',
+    'period' => '30d'
+]
+```
+
+### Top Browsers
+
+```php
+[
+    'type' => 'plausible_top_browsers',
+    'period' => '7d'
+]
+```
+
+### Top Referrers
+
+```php
+[
+    'type' => 'plausible_top_referrers',
+    'period' => '7d'
+]
+```
+
 ## Issues
 
 If there are any problems with getting this to work, please open an issue on GitHub. If you have any ideas/want to discuss new features please use the discussions feature :)

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "jackabox/statamic-plausible-analytics",
     "description": "Get your Plausible Analytics data right from your Statamic dashboard.",
-    "version": "1.1.0",
+    "version": "1.1",
     "autoload": {
         "psr-4": {
             "Jackabox\\Plausible\\": "src"

composer.lock

@@ -12,12 +12,6 @@
      */
     'site' => env('PLAUSIBLE_SITE', null),
 
-    /**
-     * Domain where your plausible instance is hosted
-     * e.g. jackwhiting.co.uk
-     */
-    'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
-
     /**
      * Do you want to use the cache?
      * True of False.