You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): layered architecture diagram, grouped key features, community (#2295)
- Replace the ASCII microkernel diagram with a generated layered diagram
(ObjectQL / ObjectOS / ObjectUI on the microkernel; everything else a plugin)
- Consolidate 14 flat Key Features bullets into 4 themed groups
- Add a Community section (star / issues / contributing)
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+13-42Lines changed: 13 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,21 +101,10 @@ From that single schema, ObjectStack compiles a running backend — the database
101
101
102
102
## Key Features
103
103
104
-
-**Built for AI, not retrofitted** — Objects, permissions, flows, APIs, and UI are declarative typed metadata, not hand-written code — small enough for an AI agent to load and safely refactor end-to-end.
105
-
-**Agent-ready metadata** — Business objects, actions, and permissions are explicit enough for AI agents to inspect and use.
106
-
-**Automatic tool surface** — Metadata can power REST APIs, client SDKs, UI views, and MCP tools without redefining each action by hand.
107
-
-**Protocol-first schemas** — All schemas are defined with Zod; TypeScript types are derived via `z.infer<>`.
-**Microkernel plugin system** — DI container, EventBus, and lifecycle hooks (init -> start -> destroy).
110
-
-**Multi-database support** — In-memory, PostgreSQL, MySQL, SQLite (via the unified SQL driver), and MongoDB. Turso/libSQL is not bundled here — it ships as the separate `@objectstack/driver-turso` package in the cloud repo.
-**Automation engine** — DAG-based flows, triggers, and workflow management.
116
-
-**AI service** — Agent, Tool, and Skill protocol built on the Vercel AI SDK.
117
-
-**Console UI** — Published ObjectUI console bundle for metadata exploration, schema inspection, API testing, and administration.
118
-
-**CLI toolchain** — `os init`, `os dev`, `os start`, `os serve`, `os validate`, and more.
104
+
-**AI-native, not retrofitted** — Objects, permissions, flows, APIs, and UI are declarative typed metadata, small enough for an agent to load end-to-end. That metadata generates an automatic tool surface — REST APIs, client SDKs, UI views, and an [MCP](packages/mcp) server — so agents inspect and act through the same contracts you defined.
105
+
-**Protocol-first runtime** — Every definition starts as a Zod schema (`z.infer<>` types), compiles into versioned, self-describing JSON artifacts, and runs on a microkernel plugin system (DI container, EventBus, `init → start → destroy` lifecycle).
-**Governance & built-ins** — better-auth, RBAC / RLS / FLS, a DAG-based automation engine, an AI service (Agent / Tool / Skill on the Vercel AI SDK), the ObjectUI Console, and a full CLI (`os init` / `dev` / `compile` / `validate` / …).
ObjectStack uses a **microkernel architecture** where the kernel provides only the essential infrastructure (DI, EventBus, lifecycle), and all capabilities are delivered as plugins. The three protocol layers sit above the kernel:
<imgsrc="docs/screenshots/layers.png"width="900"alt="ObjectStack layered architecture: the ObjectQL data layer, ObjectOS control layer, and ObjectUI view layer sit on a microkernel (plugin lifecycle, service registry / DI, event bus); every capability — drivers, server, auth, security, automation, AI — is a plugin">
331
+
</p>
367
332
368
333
See [ARCHITECTURE.md](./ARCHITECTURE.md) for the complete design documentation including the plugin lifecycle state machine, dependency graph, and design decisions.
369
334
@@ -386,6 +351,12 @@ Full documentation: **[https://docs.objectstack.ai](https://docs.objectstack.ai)
386
351
387
352
Run locally: `pnpm docs:dev`
388
353
354
+
## Community
355
+
356
+
- ⭐ **Star this repo** if ObjectStack is useful — it helps others find it.
357
+
- 🐛 Questions, bugs, or feature requests → [open an issue](https://github.com/objectstack-ai/framework/issues).
358
+
- 🤝 Want to contribute? See [CONTRIBUTING.md](./CONTRIBUTING.md).
359
+
389
360
## License
390
361
391
362
Apache-2.0. Enterprise editions, official cloud services, and marketplace
0 commit comments