Fix Plugin setup documentation in the READMEs (close #917)

Author: Paul Boocock

plugins/browser-plugin-ad-tracking/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the AdTrackingPlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { AdTrackingPlugin } from '@snowplow/browser-plugin-ad-tracking';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ AdTrackingPlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ AdTrackingPlugin() ] }); // Also stores reference at module level
 ```
 
 Then use the `trackX` functions from this package to track to all trackers which have been initialized with this plugin:

plugins/browser-plugin-ad-tracking/src/index.ts

@@ -57,15 +57,8 @@ export function AdTrackingPlugin(): BrowserPlugin {
 /**
  * Track an ad being served
  *
- * @param string impressionId Identifier for a particular ad impression
- * @param string costModel The cost model. 'cpa', 'cpc', or 'cpm'
- * @param number cost Cost
- * @param string bannerId Identifier for the ad banner displayed
- * @param string zoneId Identifier for the ad zone
- * @param string advertiserId Identifier for the advertiser
- * @param string campaignId Identifier for the campaign which the banner belongs to
- * @param object Custom context relating to the event
- * @param timestamp number or Timestamp object
+ * @param event The event information
+ * @param trackers The tracker identifiers which the event will be sent to
  */
 export function trackAdImpression(
   event: AdImpressionEvent & CommonEventProperties,
@@ -81,17 +74,8 @@ export function trackAdImpression(
 /**
  * Track an ad being clicked
  *
- * @param string clickId Identifier for the ad click
- * @param string costModel The cost model. 'cpa', 'cpc', or 'cpm'
- * @param number cost Cost
- * @param string targetUrl (required) The link's target URL
- * @param string bannerId Identifier for the ad banner displayed
- * @param string zoneId Identifier for the ad zone
- * @param string impressionId Identifier for a particular ad impression
- * @param string advertiserId Identifier for the advertiser
- * @param string campaignId Identifier for the campaign which the banner belongs to
- * @param object Custom context relating to the event
- * @param timestamp number or Timestamp object
+ * @param event The event information
+ * @param trackers The tracker identifiers which the event will be sent to
  */
 export function trackAdClick(
   event: AdClickEvent & CommonEventProperties,
@@ -107,17 +91,8 @@ export function trackAdClick(
 /**
  * Track an ad conversion event
  *
- * @param string conversionId Identifier for the ad conversion event
- * @param number cost Cost
- * @param string category The name you supply for the group of objects you want to track
- * @param string action A string that is uniquely paired with each category
- * @param string property Describes the object of the conversion or the action performed on it
- * @param number initialValue Revenue attributable to the conversion at time of conversion
- * @param string advertiserId Identifier for the advertiser
- * @param string costModel The cost model. 'cpa', 'cpc', or 'cpm'
- * @param string campaignId Identifier for the campaign which the banner belongs to
- * @param object Custom context relating to the event
- * @param timestamp number or Timestamp object
+ * @param event The event information
+ * @param trackers The tracker identifiers which the event will be sent to
  */
 export function trackAdConversion(
   event: AdConversionEvent & CommonEventProperties,

plugins/browser-plugin-browser-features/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the BrowserFeaturesPlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { BrowserFeaturesPlugin } from '@snowplow/browser-plugin-browser-features';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ BrowserFeaturesPlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ BrowserFeaturesPlugin() ] }); // Also stores reference at module level
 ```
 
 ## Copyright and license

plugins/browser-plugin-client-hints/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the BrowserFeaturesPlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { ClientHintsPlugin } from '@snowplow/browser-plugin-client-hints';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ ClientHintsPlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ ClientHintsPlugin() ] }); // Also stores reference at module level
 ```
 
 ## Copyright and license

plugins/browser-plugin-consent/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the ConsentPlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { ConsentPlugin } from '@snowplow/browser-plugin-consent';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ ConsentPlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ ConsentPlugin() ] }); // Also stores reference at module level
 ```
 
 Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

plugins/browser-plugin-ecommerce/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the EcommercePlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { EcommercePlugin } from '@snowplow/browser-plugin-ecommerce';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ EcommercePlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ EcommercePlugin() ] }); // Also stores reference at module level
 ```
 
 Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

plugins/browser-plugin-enhanced-ecommerce/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the EnhancedEcommercePlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { EnhancedEcommercePlugin } from '@snowplow/browser-plugin-enhanced-ecommerce';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ EnhancedEcommercePlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ EnhancedEcommercePlugin() ] }); // Also stores reference at module level
 ```
 
 Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

plugins/browser-plugin-error-tracking/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the ErrorTrackingPlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { ErrorTrackingPlugin } from '@snowplow/browser-plugin-error-tracking';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ ErrorTrackingPlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ ErrorTrackingPlugin() ] }); // Also stores reference at module level
 ```
 
 Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

plugins/browser-plugin-form-tracking/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the FormTrackingPlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { FormTrackingPlugin } from '@snowplow/browser-plugin-form-tracking';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ FormTrackingPlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ FormTrackingPlugin() ] }); // Also stores reference at module level
 ```
 
 Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

plugins/browser-plugin-ga-cookies/README.md

@@ -36,7 +36,7 @@ Initialize your tracker with the GaCookiesPlugin:
 import { newTracker } from '@snowplow/browser-tracker';
 import { GaCookiesPlugin } from '@snowplow/browser-plugin-ga-cookies';
 
-newTracker('sp1', '{{collector}}', { Plugins: [ GaCookiesPlugin() ] }); // Also stores reference at module level
+newTracker('sp1', '{{collector}}', { plugins: [ GaCookiesPlugin() ] }); // Also stores reference at module level
 ```
 
 ## Copyright and license