overai 1.4.4 → 1.4.5

package/README.md

@@ -4,17 +4,22 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Downloads](https://img.shields.io/npm/dm/overai.svg)](https://www.npmjs.com/package/overai)
 
-**OverAI** is the production-ready Multi AI Agents framework that lets you **Build, Deploy, and Monetize** AI agents. From simple automation scripts to full-fledged AI SaaS platforms with billing and API keys, OverAI handles the complexity so you can focus on the business logic.
+**OverAI** is the comprehensive, production-ready AI Agents framework designed for **Builders, Entrepreneurs, and Enterprise Developers**. 
 
-## 🚀 Why OverAI?
+Unlike other frameworks that stop at "Hello World", OverAI provides the full stack needed to **Build, Deploy, and Monetize** AI solutions. From simple automation scripts to full-fledged AI SaaS platforms with billing, API keys, and workflow integrations.
 
-Stop stitching together disparate tools. OverAI provides a unified "Business-in-a-Box" framework for AI developers:
+## 🚀 Why Choose OverAI?
 
-- **💰 Built-in Monetization**: Includes ready-to-use SaaS templates with **Stripe integration** and **Credit Systems**.
-- **🔌 Enterprise Integrations**: Native support for **N8N workflows**, **MCP Servers**, and **Slack**.
-- **🧠 Code-First Autonomy**: Define complex, dynamic agent behaviors using standard TypeScript/JavaScript.
-- **🤝 True Multi-Agent Collaboration**: Agents that communicate, delegate, and solve problems together.
-- **🛡️ Production-Grade**: Type-safe, CI/CD friendly, and scalable.
+### 💼 For Entrepreneurs & SaaS Builders
+*   **Business-in-a-Box**: Launch your AI API in minutes with built-in **Stripe simulation**, **Credit/Quota management**, and **API Key authentication**.
+*   **Monetization Ready**: Every agent interaction can be tracked and billed.
+*   **White-Label Friendly**: Designed to be the backend of your product.
+
+### 👨‍💻 For Developers & Engineers
+*   **Type-Safe & Scalable**: Built entirely in TypeScript for robust, maintainable code.
+*   **Multi-Agent Orchestration**: Create teams of agents that collaborate, delegate, and solve complex problems.
+*   **Protocol Agnostic**: Native support for **MCP (Model Context Protocol)** to connect with any data source.
+*   **Workflow Integration**: Seamlessly trigger agents from **N8N**, **Zapier**, or your own webhooks.
 
 ---
 
@@ -24,91 +29,145 @@ Stop stitching together disparate tools. OverAI provides a unified "Business-in-
 npm install overai
 ```
 
-## ⚡ Quick Start: Your First Agent
+---
+
+## ⚡ Quick Start: Single Agent
+
+Create a simple agent that can perform tasks.
 
 ```typescript
 import { Agent, OverAI } from 'overai';
 
 async function main() {
     const agent = new Agent({
-        name: "Helper",
-        instructions: "You are a helpful assistant.",
+        name: "Copywriter",
+        instructions: "You are an expert marketing copywriter.",
         verbose: true
     });
 
     const overAI = new OverAI({
         agents: [agent],
-        tasks: ["Say hello and introduce yourself."],
+        tasks: ["Write a catchy tagline for a new coffee brand."],
         verbose: true
     });
 
-    await overAI.start();
+    const result = await overAI.start();
+    console.log(result);
 }
 main();
 ```
 
 ---
 
-## 💸 Build Your AI SaaS in 5 Minutes
+## 🤝 Multi-Agent Collaboration
 
-OverAI includes a complete SaaS starter kit. Launch an API server with:
-- ✅ **API Key Authentication**
-- ✅ **Credit-Based Billing** (Pay-per-request)
-- ✅ **Stripe Payment Simulation**
-- ✅ **N8N Webhook Integration**
+Create a team of agents that work together.
 
-### Run the SaaS Server Example
-```bash
-# Set your OpenAI Key
-export OPENAI_API_KEY="sk-..."
+```typescript
+import { Agent, OverAI } from 'overai';
 
-# Run the pre-built SaaS server
-npx ts-node examples/saas-server.ts
-```
+async function main() {
+    const researcher = new Agent({
+        name: "Researcher",
+        instructions: "Research the latest trends in AI.",
+    });
 
-Your API is now live at `http://localhost:3001`!
+    const writer = new Agent({
+        name: "Writer",
+        instructions: "Write a blog post based on the research provided.",
+    });
 
-### Monetization Endpoints
-- **Chat**: `POST /api/v1/agent/chat` (Costs 1 credit)
-- **Top-up**: `POST /api/billing/topup` (Simulate Stripe payment)
+    const overAI = new OverAI({
+        agents: [researcher, writer],
+        tasks: [
+            "Research 3 top AI trends for 2025.",
+            "Write a short blog post summarizing these trends."
+        ],
+        verbose: true
+    });
 
-[View the full SaaS Server Code](./examples/saas-server.ts)
+    await overAI.start();
+}
+main();
+```
+
+---
+
+## 💸 SaaS & Monetization Starter Kit
+
+OverAI comes with a **complete SaaS API Server example**. Use this to launch your own AI business.
+
+### Features Included:
+- **Authentication**: Secure API Key middleware (`x-api-key`).
+- **Billing System**: Credit deduction per request (1 credit = 1 request).
+- **Payment Gateway**: Mock Stripe integration to simulate top-ups.
+- **Webhooks**: N8N compatible endpoints.
+
+### How to Run Your SaaS Backend:
+
+1. **Set your OpenAI Key**:
+   ```bash
+   export OPENAI_API_KEY="sk-..."
+   ```
+
+2. **Start the Server**:
+   ```bash
+   npx ts-node examples/saas-server.ts
+   ```
+   *Server starts at `http://localhost:3001`*
+
+3. **Test Monetization**:
+   *   **Top-up Credits** (Simulate Stripe):
+       ```bash
+       curl -X POST http://localhost:3001/api/billing/topup \
+         -H "Content-Type: application/json" \
+         -H "x-api-key: sk_demo_12345" \
+         -d '{"amount": 10.00}'
+       ```
+   *   **Paid Chat Request**:
+       ```bash
+       curl -X POST http://localhost:3001/api/v1/agent/chat \
+         -H "Content-Type: application/json" \
+         -H "x-api-key: sk_demo_12345" \
+         -d '{"message": "Hello, I paid for this!"}'
+       ```
 
 ---
 
-## 🔗 Integrations
+## 🔌 Integrations & Workflows
+
+### N8N Integration
+OverAI agents can be triggered via webhooks, making them perfect for N8N workflows.
 
-### N8N & Workflow Automation
-Expose your agents as N8N nodes or trigger workflows directly from your agents.
 ```typescript
-// Built-in webhook support for external triggers
+// Example N8N Webhook Endpoint (included in saas-server.ts)
 app.post('/api/webhook/n8n', async (req, res) => {
-    // Trigger agent workflows from N8N
+    const { workflow_data } = req.body;
+    // Process N8N data with agents...
+    res.json({ status: "success", result: agentResponse });
 });
 ```
 
 ### Model Context Protocol (MCP)
-Connect your agents to external data sources and tools using the standardized MCP protocol.
+Support for the MCP standard allows your agents to safely access local files, databases, and external tools without custom glue code.
 
 ---
 
-## 🛠️ Development Setup
+## 🛠️ Development
 
-1. Clone the repository:
-```bash
-git clone https://github.com/MervinPraison/PraisonAI.git
-cd PraisonAI/src/praisonai-ts
-```
+To contribute or modify the framework:
 
-2. Install dependencies:
-```bash
-npm install
-```
+1. **Clone your fork**:
+   ```bash
+   git clone https://github.com/your-username/overai.git
+   cd overai
+   ```
 
-3. Build the package:
-```bash
-npm run build
-```
+2. **Install & Build**:
+   ```bash
+   npm install
+   npm run build
+   ```
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "overai",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "OverAI TypeScript AI Agents Framework - Build, Deploy, and Monetize AI Agents in Minutes",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -51,7 +51,7 @@
     "ai billing",
     "ai api server"
   ],
-  "author": "Mervin Praison",
+  "author": "OverAI",
   "license": "MIT",
   "devDependencies": {
     "@ai-sdk/anthropic": "^3.0.1",