Docs

Author: pascalbaljet

README.md

@@ -9,6 +9,8 @@ https://twitter.com/pascalbaljet/status/1257926601339277312
 Laravel package to easily send events to Google Analytics
 
 ## Features
+* Use [Laravel Events](https://laravel.com/docs/7.x/events) to track events with Google Analytics
+* All API calls are queued.
 * Compatible with Laravel 6.0 and 7.0.
 * PHP 7.4 required.
 
@@ -65,9 +67,9 @@ class OrderWasPaid implements ShouldBroadcastToAnalytics
 
 There are two additional methods that lets you customize the call to Google Analytics.
 
-With the `withAnalytics` you can interact with the [underlying package](https://github.com/theiconic/php-ga-measurement-protocol) to set additional parameters. Take a look at the `TheIconic\Tracking\GoogleAnalytics\Analytics` class to see the available methods.
+With the `withAnalytics` method you can interact with the [underlying package](https://github.com/theiconic/php-ga-measurement-protocol) to set additional parameters. Take a look at the `TheIconic\Tracking\GoogleAnalytics\Analytics` class to see the available methods.
 
-With the `broadcastAnalyticsActionAs` you can customize the name of the [Event Action](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#eventAction). By default we use the class name with the class's namespace removed. This method gives you access to the underlying `Analytics` class as well.
+With the `broadcastAnalyticsActionAs` method you can customize the name of the [Event Action](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#eventAction). By default we use the class name with the class's namespace removed. This method gives you access to the underlying `Analytics` class as well.
 
 ``` php
 <?php
@@ -103,6 +105,17 @@ class OrderWasPaid implements ShouldBroadcastToAnalytics
 }
 ```
 
+## Additional configuration
+
+You can configure some additional settings in the `config/analytics-event-tracking.php` file:
+
+* `use_ssl`: Use SSL to make calls to GA
+* `anonymize_ip`: Anonymize IP when making calls to GA
+* `send_user_id`: Send the ID of the authenticated user to GA
+* `queue_name`: Specify a queue to make the calls to GA
+* `client_id_session_key`: The session key to store the Client ID
+* `http_uri`: HTTP URI to post the Client ID to (from the Blade Directive)
+
 ### Testing
 
 ``` bash

config/config.php

@@ -2,28 +2,28 @@
 
 return [
     /**
-     * Your Google Analytics Tracking ID.
+     * Your GA Tracking ID.
      * https://support.google.com/analytics/answer/1008080
      */
     'tracking_id' => env('GOOGLE_ANALYTICS_TRACKING_ID'),
 
     /**
-     * Use SSL to make calls to Google Analytics.
+     * Use SSL to make calls to GA.
      */
     'use_ssl' => true,
 
     /**
-     * Anonymize IP when making calls to Google Analytics.
+     * Anonymize IP when making calls to GA.
      */
     'anonymize_ip' => true,
 
     /**
-     * Send the ID of the authenticated user to Google Analytics.
+     * Send the ID of the authenticated user to GA.
      */
     'send_user_id' => true,
 
     /*
-     * This queue will be used to perform the API calls to Google Analytics.
+     * This queue will be used to perform the API calls to GA.
      * Leave empty to use the default queue.
      */
     'queue_name' => '',
@@ -34,7 +34,7 @@
     'client_id_session_key' => 'analytics-event-tracker-client-id',
 
     /**
-     * HTTP URI to store the Client ID.
+     * HTTP URI to post the Client ID to (from the Blade Directive).
      */
     'http_uri' => '/gaid',
 ];