roaarrr-browser/README.md

Browser analytics tracking library for roaarrr

# roaarrr Browser Analytics

A lightweight browser analytics library for tracking page views, user identification, and events.

## Installation

```bash
npm install roaarrr-browser
```

## Usage

### ES6 Modules

```javascript
// Named import
import { analytics } from 'roaarrr-browser';

// Or default import
import analytics from 'roaarrr-browser';

// Initialize with your API key
analytics.init('YOUR_API_KEY');
```

### CommonJS

```javascript
const analytics = require('roaarrr-browser');

// Initialize with your API key
analytics.init('YOUR_API_KEY');
```

### Identify Users

```javascript
analytics.identify({
  identification: 'user123',
  email: 'user@example.com',
  name: 'John Doe'
});
```

### Track Events

```javascript
analytics.funnel('button_click', {
  buttonName: 'signup',
  page: 'homepage'
});
```

## API Reference

### `init(apiKey, config?)`
Initializes the analytics library with your API key. Automatically tracks page views and navigation changes.

### `identify(userData)`
Identifies a user. Requires an `identification` field in the userData object.

### `funnel(eventName, eventData?)`
Tracks a custom event with optional event data.

## License

MIT