agentic-kit 0.1.0 → 0.1.1

package/README.md

@@ -1,12 +1,108 @@
 # Agentic Kit
 
-## Credits
+Agentic Kit is the core library providing a unified, streaming-capable interface for multiple LLM providers. It lets you plug in any supported adapter and switch between them at runtime.
 
-🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/hyperweb-io)
+## Installation
 
+```bash
+npm install agentic-kit
+# or
+yarn add agentic-kit
+```
 
-## Disclaimer
+Agentic Kit includes adapters for Ollama and Bradie out of the box.
 
-AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+## Quick Start
 
-No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.
+```typescript
+import {
+  // Adapters
+  OllamaAdapter,
+  BradieAdapter,
+
+  // Factory functions
+  createOllamaKit,
+  createBradieKit,
+  createMultiProviderKit,
+
+  // Core type
+  AgentKit
+} from 'agentic-kit';
+
+// Ollama-only client
+const ollamaKit: AgentKit = createOllamaKit('http://localhost:11434');
+const text = await ollamaKit.generate({ model: 'mistral', prompt: 'Hello' });
+console.log(text);
+
+// Bradie-only client
+const bradieKit: AgentKit = createBradieKit({
+  domain: 'http://localhost:3000',
+  onSystemMessage: (msg) => console.log('[system]', msg),
+  onAssistantReply: (msg) => console.log('[assistant]', msg),
+});
+await bradieKit.generate({ prompt: 'Hello' });
+
+// Multi-provider client
+const multiKit = createMultiProviderKit();
+multiKit.addProvider(new OllamaAdapter('http://localhost:11434'));
+multiKit.addProvider(new BradieAdapter({
+  domain: 'http://localhost:3000',
+  onSystemMessage: console.log,
+  onAssistantReply: console.log
+}));
+const reply = await multiKit.generate({ model: 'mistral', prompt: 'Hello' });
+console.log(reply);
+```
+
+## Streaming
+
+Both adapters support a streaming mode that invokes a callback for each data chunk.
+
+```typescript
+await ollamaKit.generate(
+  { model: 'mistral', prompt: 'Hello', stream: true },
+  (chunk) => console.log('Ollama chunk:', chunk)
+);
+
+await bradieKit.generate(
+  { model: 'mistral', prompt: 'Hello', stream: true },
+  (chunk) => console.log('Bradie chunk:', chunk)
+);
+```
+
+## API Reference
+
+### AgentKit
+
+- `.generate(input: GenerateInput, options?: StreamingOptions): Promise<string | void>`
+- `.listProviders(): string[]`
+- `.setProvider(name: string): void`
+- `.getCurrentProvider(): AgentProvider | undefined`
+
+### GenerateInput
+
+```ts
+interface GenerateInput {
+  model?: string;      // For services that support named models
+  prompt: string;      // The text prompt
+  stream?: boolean;    // If true, use streaming mode
+}
+```
+
+### StreamingOptions
+
+```ts
+interface StreamingOptions {
+  onChunk?: (chunk: string) => void;
+  onStateChange?: (state: string) => void;
+  onError?: (error: Error) => void;
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please submit issues and pull requests on [GitHub](https://github.com/hyperweb-io/agentic-kit).
+
+---
+
+© Hyperweb (formerly Cosmology). See LICENSE for full licensing and disclaimer. 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agentic-kit",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "description": "Agentic Kit",
   "main": "index.js",
@@ -30,9 +30,9 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@agentic-kit/bradie": "^0.1.0",
-    "@agentic-kit/ollama": "^0.1.0"
+    "@agentic-kit/bradie": "^0.1.1",
+    "@agentic-kit/ollama": "^0.1.1"
   },
   "keywords": [],
-  "gitHead": "429d3cbe616b763f2e1e8b2a35738b3f9a600c57"
+  "gitHead": "0204aa87ae43833af29965684146ff22ebf77564"
 }