Skip to content

Commit 5d09422

Browse files
committed
docs: update README tagline
1 parent 128ca58 commit 5d09422

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# AgentOS
88

9-
**Open-source TypeScript runtime for production AI agents — unified graph orchestration (AgentGraph / workflow / mission), multimodal RAG, 37 channel adapters, 5-tier guardrails, 21 LLM providers.**
9+
**TypeScript runtime for autonomous AI agents — multimodal RAG, cognitive memory, streaming guardrails, voice pipeline, and emergent multi-agent orchestration.**
1010

1111
[![npm version](https://img.shields.io/npm/v/@framers/agentos?style=flat-square&logo=npm&color=cb3837)](https://www.npmjs.com/package/@framers/agentos)
1212
[![CI](https://img.shields.io/github/actions/workflow/status/framersai/agentos/ci.yml?style=flat-square&logo=github&label=CI)](https://github.com/framersai/agentos/actions)
@@ -194,11 +194,29 @@ const assistant = agent({
194194
const session = assistant.session('tcp-demo');
195195
const reply = await session.send('Now compare TCP and UDP.');
196196
console.log(reply.text);
197+
console.log(await session.usage());
197198

198199
// Legacy format — still supported:
199200
// const result = await generateText({ model: 'openai:gpt-4o', prompt: '...' });
200201
```
201202

203+
If you want durable helper-level usage accounting outside the full runtime, enable
204+
the opt-in usage ledger:
205+
206+
```typescript
207+
import { generateText, getRecordedAgentOSUsage } from '@framers/agentos';
208+
209+
await generateText({
210+
provider: 'openai',
211+
prompt: 'Explain HTTP keep-alive.',
212+
usageLedger: { enabled: true, sessionId: 'readme-demo' },
213+
});
214+
215+
console.log(await getRecordedAgentOSUsage({ enabled: true, sessionId: 'readme-demo' }));
216+
```
217+
218+
With `enabled: true`, AgentOS writes to the shared home ledger at `~/.framers/usage-ledger.jsonl` unless you provide `usageLedger.path` or one of the ledger env vars.
219+
202220
Built-in image providers: `openai`, `openrouter`, `stability`, and `replicate`.
203221

204222
Use `providerOptions` when you need provider-native controls without leaving the

0 commit comments

Comments
 (0)