eventlog-rn 0.3.1 → 0.3.2

package/README.md

@@ -8,19 +8,21 @@
 
 ## What is this?
 
-# eventlog-rn
+**eventlog-rn** is a local-first activity tracker for React Native that helps you understand user behavior and debug issues by recording screens, actions, and errors. 
 
-Functional, type-safe event logging SDK for React Native.
+It is designed to be **safe**, **fast**, and **privacy-focused**:
+- 🏃‍♂️ **Zero performance impact**: Synchronous logging (<1ms) with batched writes.
+- 💾 **Unlimited storage**: Uses MMKV to store thousands of events.
+- 🌐 **Network Logs**: Auto-captures `fetch` and `XMLHttpRequest`.
+- 🚨 **Error Handling**: Captures crashes, promise rejections, and React render errors.
+- 🛡️ **Privacy-first**: Data stays on the device. you control when to export.
+- 🧩 **Type-safe**: Built with strict TypeScript and result types for robust error handling.
 
-Optimized for **reliability**, **performance**, and **ease of use**.
+This is **not** a cloud analytics platform. It is a tool for developers to capture local context and user journeys for debugging and support.
 
-## Features
+## Documentation
 
-- **Type-Safe**: Full TypeScript support with generics.
-- **Batched Uploads**: Efficiently queues events to minimize network requests.
-- **Offline Support**: Caches events when offline and syncs when back online.
-- **Session Tracking**: Automatic session management.
-- **Built-in UI**: Inspect logs on-device with the included Viewer component.
+📚 **[Read the Full Documentation](https://nainglynndw.github.io/eventlog-rn/)**
 
 ## Quick Start
 
@@ -35,12 +37,8 @@ npm install eventlog-rn react-native-mmkv
 ```typescript
 import { eventLog } from 'eventlog-rn';
 
-// Initialize at app launch based on your config
-eventLog.init({
-  // ...
-});
-```
-Network logging enabled by default!
+// 1. Initialize (call once at app start)
+await eventLog.init(); // Network logging enabled by default!
 
 // 2. Log events
 eventLog.screen('HomeScreen');
@@ -48,8 +46,11 @@ eventLog.action('button_clicked', { buttonId: 'checkout' });
 
 // 3. Export for debugging
 const result = await eventLog.export({ mode: 'repro' });
+```
+
+### 3. View logs (optional)
 
-// 4. View logs (optional)
+```tsx
 import { EventLogViewer, EventLogErrorBoundary } from 'eventlog-rn';
 
 // Wrap app for error handling

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eventlog-rn",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Functional, type-safe event logging SDK for React Native",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",