wirl 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,106 @@
+# Wirl
+
+Email sequence automation for developers.
+
+## Installation
+
+```bash
+npm install wirl
+```
+
+## Quick Start
+
+```typescript
+import Wirl from 'wirl';
+
+const wirl = new Wirl({
+  apiKey: 'sk_test_...',
+  baseUrl: 'https://your-wirl-instance.vercel.app'
+});
+
+// Track events
+await wirl.track({
+  email: 'user@example.com',
+  event: 'user.signup',
+  properties: { plan: 'pro' }
+});
+
+// Update contact properties
+await wirl.identify({
+  email: 'user@example.com',
+  properties: {
+    name: 'John Doe',
+    company: 'Acme Inc'
+  }
+});
+
+// Manually trigger a sequence
+await wirl.trigger({
+  email: 'user@example.com',
+  sequence: 'Welcome Sequence'
+});
+
+// Remove from a sequence
+await wirl.exit({
+  email: 'user@example.com',
+  sequence: 'Welcome Sequence'
+});
+```
+
+## API
+
+### `new Wirl(options)`
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `apiKey` | string | Yes | Your Wirl API key |
+| `baseUrl` | string | No | API base URL (default: `https://api.wirl.dev`) |
+
+### `wirl.track(params)`
+
+Track an event for a contact. Creates the contact if they don't exist.
+
+```typescript
+await wirl.track({
+  email: 'user@example.com',
+  event: 'purchase.completed',
+  properties: { amount: 99.99 }
+});
+```
+
+### `wirl.identify(params)`
+
+Create or update a contact with properties.
+
+```typescript
+await wirl.identify({
+  email: 'user@example.com',
+  properties: { name: 'John', plan: 'enterprise' }
+});
+```
+
+### `wirl.trigger(params)`
+
+Manually enroll a contact in a sequence.
+
+```typescript
+await wirl.trigger({
+  email: 'user@example.com',
+  sequence: 'Onboarding'
+});
+```
+
+### `wirl.exit(params)`
+
+Remove a contact from an active sequence.
+
+```typescript
+await wirl.exit({
+  email: 'user@example.com',
+  sequence: 'Onboarding'
+});
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wirl",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Wirl SDK for email sequence automation",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -13,7 +13,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",