docs: update README for event label

bloomscorp · Apr 5, 2024 · a61845c · a61845c
1 parent b2c9e1b
commit a61845c
Showing 1 changed file with 21 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -99,11 +99,15 @@ Use the `resolveSimpleEvent` method to log simple events
 ```ts
 import {resolveSimpleEvent} from '@bloomscorp/bloomsight.js';
 
-resolveSimpleEvent('65d735b122354c8ba6a489c2');
+resolveSimpleEvent(
+  '65d735b122354c8ba6a489c2',
+  'Contact Us CTA button'
+);
 ```
-| Option       | Type     | Description        | Mandatory | Default |
-|:-------------|:---------|:-------------------|:----------|:--------|
-| `eventToken` | `string` | Id of simple event | ✅         | NA      |
+| Option       | Type     | Description                                     | Mandatory | Default |
+|:-------------|:---------|:------------------------------------------------|:----------|:--------|
+| `eventToken` | `string` | Id of simple event                              | ✅         | NA      |
+| `label`      | `string` | a label/name for the event for future reference | ❌         | ''      |
 
 
 ### Data Event
@@ -113,15 +117,20 @@ Use the `resolveDataEvent` method to log data events
 ```ts
 import {resolveDataEvent} from '@bloomscorp/bloomsight.js';
 
-resolveDataEvent('66d735b122355c8ba6a456f8'), {
-  productId: 120,
-  sku: 'PROD021298'
-});
+resolveDataEvent(
+  '66d735b122355c8ba6a456f8',
+  {
+     productId: 120,
+     sku: 'PROD021298'
+  },
+  'Add to Wishlist CTA button'
+);
 ```
-| Option       | Type     | Description                              | Mandatory | Default |
-|:-------------|:---------|:-----------------------------------------|:----------|:--------|
-| `eventToken` | `string` | Id of data event                         | ✅         | NA      |
-| `eventData`  | `Object` | additional metadata in key, value format | ✅         | NA      |
+| Option       | Type     | Description                                     | Mandatory | Default |
+|:-------------|:---------|:------------------------------------------------|:----------|:--------|
+| `eventToken` | `string` | Id of data event                                | ✅         | NA      |
+| `eventData`  | `Object` | additional metadata in key, value format        | ✅         | NA      |
+| `label`      | `string` | a label/name for the event for future reference | ❌         | ''      |
 
 ### Page View Event