@usageflow/express 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,90 @@
+# @usageflow/express
+
+Express.js middleware for UsageFlow API tracking. Easily monitor and analyze your Express.js API usage.
+
+⚠️ **Beta Version Notice**: This package is currently in beta. Early adopters may encounter issues. We appreciate your feedback and contributions!
+
+## Installation
+
+```bash
+npm install @usageflow/express
+```
+
+## Quick Start
+
+```javascript
+const express = require('express');
+const { ExpressUsageFlowAPI } = require('@usageflow/express');
+
+const app = express();
+app.use(express.json());
+
+// Initialize UsageFlow
+const usageFlow = new ExpressUsageFlowAPI();
+usageFlow.init('YOUR_API_KEY');
+
+// Create middleware
+const middleware = usageFlow.createMiddleware(
+  [
+    { method: '*', url: '*' }, // Track all routes
+  ],
+  [
+    { method: 'GET', url: '/api/health' }, // Whitelist health check
+  ]
+);
+
+// Apply middleware
+app.use(middleware);
+
+// Your routes
+app.get('/api/users', (req, res) => {
+  res.json({ users: ['John', 'Jane'] });
+});
+
+app.listen(3000, () => {
+  console.log('Server running on port 3000');
+});
+```
+
+## TypeScript Support
+
+```typescript
+import express from 'express';
+import { ExpressUsageFlowAPI } from '@usageflow/express';
+
+const app = express();
+app.use(express.json());
+
+const usageFlow = new ExpressUsageFlowAPI();
+usageFlow.init('YOUR_API_KEY');
+
+// Rest of the code remains the same
+```
+
+## Configuration Options
+
+```typescript
+interface Route {
+    method: string;  // HTTP method or '*' for all methods
+    url: string;     // URL pattern or '*' for all URLs
+}
+
+usageFlow.createMiddleware(
+    routes: Route[],           // Routes to track
+    whitelistRoutes?: Route[] // Routes to exclude from tracking
+);
+```
+
+## Beta Status
+
+This is a beta release meant for early adopters. You may encounter:
+
+- API changes in future versions
+- Incomplete features
+- Potential bugs
+
+We're actively working on improvements and appreciate your feedback!
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usageflow/express",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "UsageFlow plugin for Express applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",