diff --git a/README.md b/README.md
index 22f5cf9..a878118 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,39 @@
-# IronTelemetry SDK for JavaScript/TypeScript
+
+
+ 
+
+
-Error monitoring and crash reporting SDK for JavaScript and TypeScript applications. Capture exceptions, track user journeys, and get insights to fix issues faster.
+IronTelemetry SDK for JavaScript/TypeScript
-[](https://www.npmjs.com/package/@ironservices/telemetry)
-[](https://opensource.org/licenses/MIT)
+
+ Error monitoring and crash reporting for modern applications
+
+
+
+ 
+ 
+
+
+
+ Website •
+ Documentation •
+ JavaScript Guide •
+ GitHub
+
+
+---
+
+**IronTelemetry** helps you capture exceptions, track user journeys, and get actionable insights to fix issues faster. Built for developers who want simple, powerful error monitoring without the complexity.
+
+## Features
+
+- **Exception Capture** - Automatically capture and report exceptions with full stack traces
+- **Journey Tracking** - Understand what users did before an error occurred
+- **Breadcrumbs** - Add context with custom breadcrumbs and metadata
+- **Source Maps** - See original source code in stack traces
+- **Lightweight** - Minimal footprint, no impact on performance
+- **TypeScript First** - Full TypeScript support with type definitions
## Installation
@@ -17,15 +47,17 @@ pnpm add @ironservices/telemetry
## Quick Start
-### Basic Exception Capture
+### Initialize the SDK
```typescript
import IronTelemetry from '@ironservices/telemetry';
-// Initialize with your DSN
IronTelemetry.init('https://pk_live_xxx@irontelemetry.com');
+```
-// Capture exceptions
+### Capture Exceptions
+
+```typescript
try {
doSomething();
} catch (error) {
@@ -41,151 +73,102 @@ try {
}
```
-### Journey Tracking
-
-Track user journeys to understand the context of errors:
+### Track User Journeys
```typescript
+// Start a journey
+const journey = IronTelemetry.startJourney('checkout', { userId: 'user-123' });
+
+// Add steps
+journey.step('add_to_cart', { productId: 'prod-456' });
+journey.step('enter_shipping');
+journey.step('enter_payment');
+
+// Complete or fail
+journey.complete(); // or journey.fail('Payment declined');
+```
+
+### Add Breadcrumbs
+
+```typescript
+IronTelemetry.addBreadcrumb({
+ category: 'user',
+ message: 'Clicked checkout button',
+ level: 'info',
+});
+```
+
+### Set User Context
+
+```typescript
+IronTelemetry.setUser({
+ id: 'user-123',
+ email: 'user@example.com',
+ name: 'John Doe',
+});
+```
+
+## Framework Integrations
+
+### Express.js
+
+```typescript
+import express from 'express';
import IronTelemetry from '@ironservices/telemetry';
-// Track a complete user journey
-{
- using journey = IronTelemetry.startJourney('Checkout Flow');
+const app = express();
- IronTelemetry.setUser('user-123', 'user@example.com');
+// Add error handler
+app.use(IronTelemetry.express.errorHandler());
+```
- {
- using step = IronTelemetry.startStep('Validate Cart', 'business');
- validateCart();
- }
+### React
- {
- using step = IronTelemetry.startStep('Process Payment', 'business');
- processPayment();
- }
+```typescript
+import { ErrorBoundary } from '@ironservices/telemetry/react';
- {
- using step = IronTelemetry.startStep('Send Confirmation', 'notification');
- sendConfirmationEmail();
- }
+function App() {
+ return (
+ }>
+
+
+ );
}
```
-Any exceptions captured during the journey are automatically correlated.
-
-## Configuration
+## Configuration Options
```typescript
-import IronTelemetry from '@ironservices/telemetry';
-
-IronTelemetry.init({
- dsn: 'https://pk_live_xxx@irontelemetry.com',
+IronTelemetry.init('https://pk_live_xxx@irontelemetry.com', {
environment: 'production',
- appVersion: '1.2.3',
- sampleRate: 1.0, // 100% of events
- debug: false,
- beforeSend: (event) => !event.message?.includes('expected error'),
+ release: '1.0.0',
+ sampleRate: 1.0,
+ beforeSend: (event) => {
+ // Filter or modify events
+ return event;
+ },
});
```
-### Configuration Options
+## Documentation
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `dsn` | string | required | Your Data Source Name |
-| `environment` | string | 'production' | Environment name |
-| `appVersion` | string | '0.0.0' | Application version |
-| `sampleRate` | number | 1.0 | Sample rate (0.0 to 1.0) |
-| `maxBreadcrumbs` | number | 100 | Max breadcrumbs to keep |
-| `debug` | boolean | false | Enable debug logging |
-| `beforeSend` | function | - | Hook to filter/modify events |
-| `enableOfflineQueue` | boolean | true | Enable offline queue |
-| `maxOfflineQueueSize` | number | 500 | Max offline queue size |
+For complete documentation, visit [irontelemetry.com/docs](https://irontelemetry.com/docs).
-## Features
+## Other SDKs
-- **Automatic Exception Capture**: Capture and report exceptions with full stack traces
-- **Journey Tracking**: Track user flows and correlate errors with context
-- **Breadcrumbs**: Leave a trail of events leading up to an error
-- **User Context**: Associate errors with specific users
-- **Tags & Extras**: Add custom metadata to your events
-- **Offline Queue**: Events are queued when offline and sent when connectivity returns
-- **Sample Rate**: Control the volume of events sent
-- **Before Send Hook**: Filter or modify events before sending
+| Platform | Package |
+|----------|---------|
+| .NET | [IronTelemetry.Client](https://git.marketally.com/ironservices/irontelemetry-dotnet) |
+| Python | [irontelemetry](https://git.marketally.com/ironservices/irontelemetry-python) |
+| Go | [irontelemetry-go](https://git.marketally.com/ironservices/irontelemetry-go) |
+| Java | [irontelemetry-java](https://git.marketally.com/ironservices/irontelemetry-java) |
+| Rust | [irontelemetry](https://git.marketally.com/ironservices/irontelemetry-rust) |
-## Breadcrumbs
+## Support
-```typescript
-// Add breadcrumbs to understand what happened before an error
-IronTelemetry.addBreadcrumb('User clicked checkout button', 'ui');
-IronTelemetry.addBreadcrumb('Payment API called', 'http');
-
-// Or with full control
-IronTelemetry.addBreadcrumb({
- category: 'auth',
- message: 'User logged in',
- level: 'info',
- data: { userId: '123' },
-});
-```
-
-## Global Exception Handling
-
-```typescript
-import IronTelemetry, { useUnhandledExceptionHandler } from '@ironservices/telemetry';
-
-IronTelemetry.init('your-dsn');
-useUnhandledExceptionHandler();
-```
-
-This sets up handlers for:
-- Browser: `window.onerror` and `unhandledrejection`
-- Node.js: `uncaughtException` and `unhandledRejection`
-
-## Helper Methods
-
-```typescript
-import { trackStep, trackStepAsync } from '@ironservices/telemetry';
-
-// Track a step with automatic error handling
-trackStep('Process Order', () => {
- processOrder();
-});
-
-// Async version
-await trackStepAsync('Fetch Data', async () => {
- await fetchData();
-});
-
-// With return value
-const result = trackStep('Calculate Total', () => {
- return calculateTotal();
-});
-```
-
-## Flushing
-
-```typescript
-// Flush pending events before app shutdown
-await IronTelemetry.flush();
-```
-
-## TypeScript Support
-
-This package is written in TypeScript and includes full type definitions:
-
-```typescript
-import IronTelemetry, {
- TelemetryOptions,
- TelemetryEvent,
- Breadcrumb,
- SeverityLevel
-} from '@ironservices/telemetry';
-```
-
-## Browser Support
-
-Works in all modern browsers (Chrome, Firefox, Safari, Edge) and Node.js 16+.
+- **Documentation**: [irontelemetry.com/docs](https://irontelemetry.com/docs)
+- **Email**: dev@ironservices.io
+- **Issues**: [git.marketally.com/ironservices/irontelemetry-js/issues](https://git.marketally.com/ironservices/irontelemetry-js/issues)
## License