Skip to content

Commit b9d77ed

Browse files
Aegisclaude
authored andcommitted
docs: update README for @stackbilt/aegis-core identity + cleanup
- Add package name prominently: "Published as @stackbilt/aegis-core" - Add "Two ways to use AEGIS" (standalone vs dependency) in intro - Add "Use as a Dependency" section with install, createAegisApp() example, and link to CONTRIBUTING.md for full docs - Delete orphaned CLAUDE.md.pre-adf-migrate.bak Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 85d82f4 commit b9d77ed

2 files changed

Lines changed: 35 additions & 76 deletions

File tree

CLAUDE.md.pre-adf-migrate.bak

Lines changed: 0 additions & 76 deletions
This file was deleted.

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,18 @@
1111
[![Discord](https://img.shields.io/discord/1485683351393407006?color=7289da&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/aJmE8wmQDS)
1212

1313
**A persistent AI agent framework for Cloudflare Workers.**
14+
**Published as `@stackbilt/aegis-core` — use standalone or extend as a dependency.**
1415

1516
Cognitive kernel with multi-tier memory, autonomous goal pursuit, a dreaming cycle, runtime tool creation, and 26 scheduled tasks. Deploy your own persistent AI co-founder on the edge.
1617

1718
## What is AEGIS?
1819

1920
AEGIS is a framework for building **personal AI agents** that remember everything, pursue goals autonomously, create their own tools, and improve themselves while you sleep. Unlike chat-based AI tools that forget between sessions, AEGIS maintains persistent identity, memory, and state across every interaction.
2021

22+
**Two ways to use AEGIS:**
23+
- **Standalone** — Clone, configure, deploy. Full agent in minutes.
24+
- **As a dependency**`npm install @stackbilt/aegis-core` and extend with your own routes, scheduled tasks, executors, and MCP tools via `createAegisApp()`.
25+
2126
The production instance runs 26 scheduled tasks, has executed 236+ autonomous coding sessions, and costs $0/month to host (Cloudflare Workers free tier + Workers AI for inference).
2227

2328
Built on Cloudflare Workers for edge-native deployment. Zero cold starts. Global distribution. Pay-per-request economics.
@@ -62,6 +67,36 @@ npx wrangler deploy
6267

6368
Visit `https://your-worker.workers.dev` and authenticate with your AEGIS_TOKEN.
6469

70+
## Use as a Dependency
71+
72+
Install `@stackbilt/aegis-core` and compose your own agent:
73+
74+
```bash
75+
npm install @stackbilt/aegis-core
76+
```
77+
78+
```ts
79+
import { createAegisApp } from '@stackbilt/aegis-core';
80+
81+
const aegis = createAegisApp({
82+
operator: myConfig,
83+
routes: [{ prefix: '/', router: myRoutes }],
84+
scheduledTasks: [myCustomTask],
85+
});
86+
87+
export default {
88+
fetch: aegis.app.fetch,
89+
scheduled: (e, env, ctx) => ctx.waitUntil(aegis.runScheduled(buildEdgeEnv(env))),
90+
};
91+
```
92+
93+
Core provides: kernel, memory, dispatch, base routes, MCP server, scheduled task framework.
94+
You provide: operator config, custom routes, integrations, secrets.
95+
96+
Extension interfaces: `ScheduledTaskPlugin`, `ExecutorPlugin`, `RoutePlugin`, `McpToolPlugin`.
97+
98+
See [CONTRIBUTING.md](CONTRIBUTING.md#using-as-a-dependency) for full documentation.
99+
65100
## Architecture
66101

67102
```

0 commit comments

Comments
 (0)