docs: rewrite README.md to accurately reflect objectstack-ai/framework v4.0.1

[Copilot]

The README was stale — wrong repo identity, broken clone URL, missing packages, and outdated metrics. This rewrites it to match the actual state of the framework monorepo.

Changes

README.md

• Title: ObjectStack Protocol → ObjectStack Framework; tagline updated to match repo description
• Badges: added v4.0.1 and 6,507 tests passing
• Clone URL: objectstack-ai/spec.git → objectstack-ai/framework.git
• Added missing packages across three new categories:
  • Drivers: driver-sql, driver-turso
  • Plugins: plugin-audit, plugin-setup
  • Services: service-feed, service-automation, service-ai, service-realtime, service-i18n
• Codebase metrics updated: 27 packages, 200 Zod schema files, 1,600+ exported schemas, 8,750+ .describe() annotations, 229 test files
• Architecture section now includes the kernel ASCII diagram from ARCHITECTURE.md
• Docs URL updated to https://docs.objectstack.ai
• Section order restructured: What is ObjectStack → Key Features → Quick Start → Scripts → CLI → Package Directory → Metrics → Architecture → Roadmap → Contributing → Docs → License

CHANGELOG.md

• Appended ### Documentation entry under [Unreleased] summarising the README rewrite; no existing entries modified

Original prompt

Objective

Rewrite the root README.md for the objectstack-ai/framework repository to be comprehensive, accurate, and well-structured. The current README has several issues:

1. Stale references — The "For Protocol Developers" clone URL points to objectstack-ai/spec.git (the old repo name), but this repo is now objectstack-ai/framework.
2. Repository description mismatch — The current README titles itself "ObjectStack Protocol" but the repo description is: "The ObjectStack Developer Framework. Microkernel runtime, CLI toolchain, official plugins, framework adapters, and Studio IDE — orchestrating ObjectQL, ObjectOS, and ObjectUI into a unified development experience."
3. Missing packages — Several packages that exist now are not listed: @objectstack/driver-sql, @objectstack/driver-turso, @objectstack/plugin-audit, @objectstack/plugin-setup, @objectstack/service-feed, @objectstack/service-automation, @objectstack/service-ai, @objectstack/service-realtime, @objectstack/service-i18n.
4. Outdated metrics — The ROADMAP says 27 packages, 200 Zod schema files, 1,600+ exported schemas, 8,750+ .describe() annotations, 6,507 tests passing, 229 test files. The README has older numbers (175 schemas, 25 packages).
5. Current version is v4.0.1 — The README doesn't reflect this.

Requirements for the new README

Title & Badges

• Title: ObjectStack Framework
• Badges: TypeScript, License (Apache 2.0), Version (v4.0.1), Tests (6,507 passing)
• Tagline should reflect the repo description: a metadata-driven developer framework with microkernel runtime, CLI toolchain, official plugins, framework adapters, and Studio IDE.

Structure (in order)

1. What is ObjectStack — Brief overview of the three-layer protocol stack (ObjectQL / ObjectOS / ObjectUI) and the microkernel architecture. Mention it's metadata-driven. Link to ARCHITECTURE.md.
2. Key Features — Bullet list of standout features: Protocol-first (Zod schemas), Microkernel plugin system, Multi-database support (Memory, PostgreSQL, MySQL, SQLite, Turso/libSQL), 7 framework adapters, Client SDK + React hooks, Built-in auth (better-auth), RBAC/RLS/FLS security, Automation engine (DAG-based flows), AI service (Vercel AI SDK), Studio IDE, CLI toolchain.
3. Quick Start — Two paths:
   • For Application Developers: npx @objectstack/cli init my-app → os dev → os studio
   • For Framework Contributors: git clone https://github.com/objectstack-ai/framework.git (MUST be framework, not spec!) → pnpm install → pnpm build → pnpm test → pnpm docs:dev
4. Monorepo Scripts — Table of available pnpm scripts from root package.json.
5. CLI Commands — os init, os dev, os studio, os serve, os compile, os validate, os info, os generate, os doctor
6. Package Directory — Organized by category with tables. Each category:
   • Core (spec, core, types)
   • Engine (objectql, runtime, metadata, rest)
   • Drivers (driver-memory, driver-sql, driver-turso)
   • Client (client, client-react)
   • Plugins (plugin-hono-server, plugin-msw, plugin-auth, plugin-security, plugin-dev, plugin-audit, plugin-setup)
   • Services (service-feed, service-automation, service-ai, service-realtime, service-i18n)
   • Framework Adapters (express, fastify, hono, nestjs, nextjs, nuxt, sveltekit)
   • Tools & Apps (cli, create-objectstack, vscode-objectstack, studio, docs)
   • Examples (app-todo, app-crm, app-host, plugin-bi)
7. Codebase Metrics — Compact table with: 27 packages, 200 Zod schema files, 1,600+ exported schemas, 8,750+ .describe() annotations, 27 service contracts, 229 test files, 6,507 tests passing.
8. Architecture — Brief description of microkernel + three-layer stack with an ASCII diagram from ARCHITECTURE.md. Link to ARCHITECTURE.md.
9. Roadmap — Brief summary. Link to ROADMAP.md and apps/studio/ROADMAP.md.
10. Contributing — Brief. Link to CONTRIBUTING.md. Mention key standards (Zod-first, camelCase config, snake_case data).
11. Documentation — Link to https://docs.objectstack.ai and pnpm docs:dev.
12. License — Apache 2.0 © ObjectStack

Style Guidelines

• Write in English with professional tone.
• Use concise descriptions — avoid bloating tables.
• All clone URLs must reference objectstack-ai/framework (NOT spec).
• Homepage: https://docs.objectstack.ai
• Version: v4.0.1
• No emojis in section headings (use them sparingly if at all).
• File links should use relative paths like ./ARCHITECTURE.md, ./ROADMAP.md, ./CONTRIBUTING.md.
• Package links should use relative paths like packages/spec, packages/core, etc.

After completing:

1. Make sure CHANGELOG.md has an entry for this README rewrite under [Unreleased] → ### Documentation section. If the section doesn't exist, add it. Do NOT remove or modify any existing entries in CHANGELOG.md — only append.
2. Do NOT modify ROADMAP.md or any o...

This pull request was created from Copilot chat.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
objectstack-play	Ready	Preview, Comment	Apr 2, 2026 6:18am
spec	Ready	Preview, Comment	Apr 2, 2026 6:18am