praisonai 1.0.2 → 1.0.3

package/README.md

@@ -26,20 +26,118 @@ npm install
 npm run build
 ```
 
-## Running Examples
+## Usage
+
+Here are examples of different ways to use PraisonAI:
+
+### 1. Single Agent Example
+
+```typescript
+import { SimpleAgent, OpenAIService } from 'praisonai';
+
+async function main() {
+    // Initialize a single agent with OpenAI
+    const llm = new OpenAIService({
+        apiKey: process.env.OPENAI_API_KEY
+    });
+    
+    const agent = new SimpleAgent({
+        llm,
+        name: 'ResearchAssistant',
+        description: 'An AI assistant that helps with research tasks'
+    });
+
+    // Execute a task
+    const response = await agent.execute('Summarize the key concepts of quantum computing');
+    console.log('Agent Response:', response);
+}
+
+main();
+```
+
+### 2. Multi-Agent Example
+
+```typescript
+import { SimpleAgent, OpenAIService, MultiAgentSystem } from 'praisonai';
+
+async function main() {
+    const llm = new OpenAIService({
+        apiKey: process.env.OPENAI_API_KEY
+    });
+
+    // Create multiple agents
+    const researcher = new SimpleAgent({
+        llm,
+        name: 'Researcher',
+        description: 'Researches and gathers information'
+    });
+
+    const writer = new SimpleAgent({
+        llm,
+        name: 'Writer',
+        description: 'Writes and formats content'
+    });
+
+    // Create multi-agent system
+    const system = new MultiAgentSystem([researcher, writer]);
+    
+    // Execute collaborative task
+    const result = await system.execute('Research and write a summary about AI agents');
+    console.log('Multi-Agent Result:', result);
+}
+
+main();
+```
 
-The package includes several examples to help you get started. To run an example:
+### 3. Task-Based Agent Example
 
-1. Build the package first:
+```typescript
+import { SimpleAgent, OpenAIService, Task, ArxivSearchTool } from 'praisonai';
+
+async function main() {
+    const llm = new OpenAIService({
+        apiKey: process.env.OPENAI_API_KEY
+    });
+
+    // Create agent with tools
+    const agent = new SimpleAgent({
+        llm,
+        name: 'ResearchAgent',
+        tools: [new ArxivSearchTool()]
+    });
+
+    // Create and execute a task
+    const task = new Task({
+        objective: 'Find recent quantum computing papers',
+        steps: [
+            'Search for quantum computing papers',
+            'Summarize the findings'
+        ]
+    });
+
+    const result = await agent.executeTask(task);
+    console.log('Task Result:', result);
+}
+
+main();
+```
+
+### Running the Examples
+
+1. First, set up your environment variables:
 ```bash
-npm run build
+export OPENAI_API_KEY='your-api-key'
 ```
 
-2. Run an example using ts-node:
+2. Create a new TypeScript file (e.g., `example.ts`) with any of the above examples.
+
+3. Run the example:
 ```bash
-npx ts-node examples/arxiv-search.ts
+npx ts-node example.ts
 ```
 
+For more examples, check out the `examples/concepts/` directory in the repository.
+
 ## Package Structure
 
 ```
@@ -56,27 +154,6 @@ src/
     └── ... (other tools)
 ```
 
-## Usage
-
-Here's a simple example of using the ArxivSearchTool:
-
-```typescript
-import { ArxivSearchTool } from 'praisonai';
-
-async function main() {
-    const searchTool = new ArxivSearchTool();
-    const papers = await searchTool.execute('quantum computing', 5);
-    
-    papers.forEach(paper => {
-        console.log(`Title: ${paper.title}`);
-        console.log(`Authors: ${paper.authors.join(', ')}`);
-        console.log('---');
-    });
-}
-
-main();
-```
-
 ## Contributing
 
 1. Fork the repository

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "praisonai",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "PraisonAI TypeScript AI Agents Framework - Node.js, npm, and Javascript AI Agents Framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -60,7 +60,7 @@
     "dotenv": "^16.4.1",
     "fast-xml-parser": "^4.3.4",
     "openai": "^4.24.7",
-    "praisonai": "^1.0.0"
+    "praisonai": "^1.0.2"
   },
   "engines": {
     "node": ">=14.0.0"