@reservamos/browser-analytics 0.1.3 → 0.1.4-alpha.2

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change Log
 
+## 0.2.0
+
+- Breaking Change: Import individual init, track and identify functions is no longer available.
+- Breaking Change: The track events are now under the `track` property. So `analytics.trackEventName` now becomes `analytics.track.eventName`.
+- Implement new folder structure.
+  - Add services
+  - Add a folder per event
+- Refactor mixpanel, fingerprint and validator to become services
+
+## 0.1.3
+
+- Added publish action
+
 ## 0.1.1
+
 - Added `zod` dependency to validate schema formats
 
 ## 0.1.0

package/README.md

@@ -16,20 +16,14 @@ This library is a lightweight and optimized solution for tracking user events an
 To install the library, use npm or yarn
 
 ```bash
-  npm install reservamos-browser-analytics
+  npm install @reservamos/browser-analytics
 ```
 
 ## Usage
 
 ```typescript
-// Import the tracker
-import tracker from '@reservamos/browser-analytics';
-
-// Also import the InitConfig interface if you want to use type safety
-// import tracker, { InitConfig } from "@reservamos/browser-analytics";
-
-// You can also import only the functions you need
-// import { init, track, identify } from "@reservamos/browser-analytics";
+// Import the tracker and the InitConfig interface if you want to use type safety
+import analytics, { InitConfig } from '@reservamos/browser-analytics';
 
 // Define the configuration for the tracker
 const config: InitConfig = {
@@ -39,13 +33,31 @@ const config: InitConfig = {
 };
 
 // Initialize the tracker with the config
-tracker.init(config);
+analytics.init(config);
 
 // Listen for the "Tracker Ready" event
 window.addEventListener('Tracker Ready', () => {
   console.log('Tracker Ready');
 
   // Track a test event
-  tracker.trackTest();
+  analytics.track.test();
+});
+```
+
+## Identifying Users
+
+The `identify` method accepts a main identifier and an object containing user information. The object has four predefined fields: `email`, `firstName`, `lastName`, and `phone`. In addition to these, you can include any custom fields to store additional user-specific information as needed.
+
+```typescript
+import analytics from '@reservamos/browser-analytics';
+
+// Identify the user with the main identifier and additional information
+
+analytics.identify('main-identifier', {
+  email: 'example',
+  firstName: 'John',
+  lastName: 'Doe',
+  phone: '123456789',
+  salesforceId: '123456789',
 });
 ```