ainamika-sdk 1.2.5 → 1.2.6

package/README.md

@@ -41,14 +41,42 @@ Sign up at [AInamika Dashboard](https://ainamika.netlify.app) and create a proje
 
 ### 2. Initialize the SDK
 
+#### Minimal Configuration (Recommended Start)
+
+The simplest way to get started - just 3 lines:
+
+```javascript
+import AInamikaSDK from 'ainamika-sdk';
+
+const analytics = new AInamikaSDK({
+  projectKey: 'proj_xxxxxxxxxx',   // Get this from your dashboard
+  autoConfig: true,                // AI-powered auto-configuration
+  clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'  // Your client ID
+});
+```
+
+That's it! The SDK will automatically track clicks, form submissions, page views, performance metrics, and engagement.
+
+#### Full Configuration
+
+For more control, you can configure all options:
+
 ```javascript
 import AInamikaSDK from 'ainamika-sdk';
 
 const analytics = new AInamikaSDK({
   projectKey: 'proj_xxxxxxxxxx',  // Get this from your dashboard
   autoConfig: true,               // AI-powered auto-configuration
+  clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
   debug: false,                   // Set to true for development
 
+  // Extra config - custom data included with ALL events
+  extraConfig: {
+    appVersion: '2.0.0',          // Your app version
+    environment: 'production',    // Environment name
+    deviceId: 'device_abc123'     // Custom device identifier
+  },
+
   // Enable advanced tracking (enabled by default)
   advancedTracking: {
     enabled: true,
@@ -226,9 +254,9 @@ analytics.trackConversion('newsletter_subscribe', undefined, {
 
 ```javascript
 const analytics = new AInamikaSDK({
-  // Authentication (one required)
-  projectKey: 'proj_xxxxxxxxxx',    // Recommended: Project-based auth
-  clientId: 'your-client-id',       // Legacy: Client-based auth
+  // Required for authentication
+  projectKey: 'proj_xxxxxxxxxx',    // Get from your dashboard
+  clientId: 'your-client-id',       // Your unique client identifier
 
   // Auto-Configuration
   autoConfig: true,                 // Enable AI-powered DOM analysis
@@ -242,12 +270,13 @@ const analytics = new AInamikaSDK({
     batchInterval: 5000             // Batch interval in ms (default: 5000)
   },
 
-  // Extra Config - Custom data included with ALL events
+  // Extra Config - Custom data included with ALL events (IMPORTANT!)
   extraConfig: {
-    appVersion: '2.0.0',            // Your app version
-    environment: 'production',      // Environment name
-    deviceId: 'device_abc123',      // Custom device ID
-    buildNumber: '1234'             // Any custom data you need
+    appVersion: '2.0.0',            // Your app version (recommended)
+    environment: 'production',      // Environment: 'development', 'staging', 'production'
+    deviceId: 'device_abc123',      // Custom device identifier
+    buildNumber: '1234',            // Build/release number
+    // Add any custom fields you need - they'll be included in every event
   },
 
   // Advanced Tracking (NEW)
@@ -266,7 +295,7 @@ const analytics = new AInamikaSDK({
   // Error Tracking
   errorTracking: {
     enabled: true,                  // Enable error tracking
-    captureScreenshots: true,       // Capture screenshots on error
+    captureScreenshots: false,      // Capture screenshots on error (default: false)
     captureDomSnapshots: true,      // Capture DOM state on error
     maxStackTraceDepth: 50,         // Stack trace depth limit
     maxErrorsPerSession: 100,       // Max errors per session
@@ -311,16 +340,23 @@ All events include:
 
 ### Extra Config
 
-Pass custom data that will be included with **every event**:
+Pass custom data that will be included with **every event**. This is useful for tracking app version, environment, device info, and user context across all analytics.
+
+**Common fields:**
+- `appVersion` - Your application version (e.g., '2.0.0')
+- `environment` - Environment name ('development', 'staging', 'production')
+- `deviceId` - Custom device identifier for cross-session tracking
 
 ```javascript
 // Set during initialization
 const analytics = new AInamikaSDK({
-  projectKey: 'proj_xxx',
+  projectKey: 'proj_xxxxxxxxxx',
+  clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  autoConfig: true,
   extraConfig: {
     appVersion: '2.0.0',
     environment: 'production',
-    region: 'us-east'
+    deviceId: 'device_abc123'
   }
 });
 
@@ -489,9 +525,14 @@ import AInamikaSDK from 'ainamika-sdk';
 import { useEffect } from 'react';
 
 const analytics = new AInamikaSDK({
-  projectKey: 'proj_xxx',
+  projectKey: 'proj_xxxxxxxxxx',
+  clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
   autoConfig: true,
-  advancedTracking: { enabled: true }
+  extraConfig: {
+    appVersion: '2.0.0',
+    environment: 'production',
+    deviceId: 'device_abc123'
+  }
 });
 
 function App() {
@@ -526,12 +567,13 @@ let analytics = null;
 export function getAnalytics() {
   if (typeof window !== 'undefined' && !analytics) {
     analytics = new AInamikaSDK({
-      projectKey: 'proj_xxx',
+      projectKey: 'proj_xxxxxxxxxx',
+      clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
       autoConfig: true,
-      advancedTracking: {
-        enabled: true,
-        trackPerformance: true,
-        trackEngagement: true
+      extraConfig: {
+        appVersion: process.env.NEXT_PUBLIC_APP_VERSION || '1.0.0',
+        environment: process.env.NODE_ENV,
+        deviceId: 'device_abc123'
       }
     });
   }
@@ -573,10 +615,21 @@ function MyApp({ Component, pageProps }) {
   <button id="game-btn" customdata='{"name":"Puzzle Master"}'>Play Game</button>
 
   <script>
+    // Minimal setup - just 3 required fields
     const analytics = new AInamikaSDKPro({
-      projectKey: 'proj_xxx',
+      projectKey: 'proj_xxxxxxxxxx',
+      clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
       autoConfig: true,
-      debug: true,
+
+      // Optional: Add extra config for better tracking
+      extraConfig: {
+        appVersion: '2.0.0',
+        environment: 'production',
+        deviceId: 'device_abc123'
+      },
+
+      // Optional: Configure advanced tracking
+      debug: false,
       advancedTracking: {
         enabled: true,
         trackPerformance: true,