Skip to content

Commit 1635d3d

Browse files
Merge pull request #499 from objectstack-ai/copilot/update-readme-for-packages
2 parents 662327a + cf245d0 commit 1635d3d

10 files changed

Lines changed: 2019 additions & 32 deletions

File tree

README.md

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -132,40 +132,60 @@ See **[DEVELOPMENT.md](./DEVELOPMENT.md)** for comprehensive development guide i
132132

133133
### Core Packages
134134

135-
| Package | Description | Status |
136-
| :--- | :--- | :--- |
137-
| **[`@objectstack/spec`](packages/spec)** | Protocol definitions (Zod schemas, Types, JSON Schemas) - The "Constitution" | 🟢 Active |
138-
| **[`@objectstack/core`](packages/core)** | Microkernel runtime (Plugin system, DI, Event Bus, Logger) | 🟢 Active |
139-
| **[`@objectstack/types`](packages/types)** | Shared runtime type definitions | 🟢 Active |
135+
| Package | Description | Key Features | Status |
136+
| :--- | :--- | :--- | :--- |
137+
| **[`@objectstack/spec`](packages/spec)** | Protocol definitions (Zod schemas, Types, JSON Schemas) - The "Constitution" | Runtime validation, Type inference, JSON Schema generation | 🟢 Active |
138+
| **[`@objectstack/core`](packages/core)** | Microkernel runtime (Plugin system, DI, Event Bus, Logger) | Plugin lifecycle, Service registry, High-performance logging | 🟢 Active |
139+
| **[`@objectstack/types`](packages/types)** | Shared runtime type definitions | IKernel, RuntimePlugin, RuntimeContext interfaces | 🟢 Active |
140140

141141
### Engine Packages
142142

143-
| Package | Description | Status |
144-
| :--- | :--- | :--- |
145-
| **[`@objectstack/objectql`](packages/objectql)** | ObjectQL query engine and schema registry | 🟢 Active |
146-
| **[`@objectstack/runtime`](packages/runtime)** | Runtime utilities and plugin helpers | 🟢 Active |
143+
| Package | Description | Key Features | Status |
144+
| :--- | :--- | :--- | :--- |
145+
| **[`@objectstack/objectql`](packages/objectql)** | ObjectQL query engine and schema registry | Cross-datasource queries, Driver routing, Schema registry | 🟢 Active |
146+
| **[`@objectstack/runtime`](packages/runtime)** | Runtime utilities and plugin helpers | Standard library, DriverPlugin, AppPlugin | 🟢 Active |
147+
| **[`@objectstack/metadata`](packages/metadata)** | Metadata loading and persistence | Multi-format support, File watching, Validation | 🟢 Active |
147148

148149
### Client Packages
149150

150-
| Package | Description | Status |
151-
| :--- | :--- | :--- |
152-
| **[`@objectstack/client`](packages/client)** | Official Client SDK for ObjectStack Protocol | 🟢 Active |
153-
| **[`@objectstack/client-react`](packages/client-react)** | React hooks for ObjectStack | 🟢 Active |
151+
| Package | Description | Key Features | Status |
152+
| :--- | :--- | :--- | :--- |
153+
| **[`@objectstack/client`](packages/client)** | Official Client SDK for ObjectStack Protocol | CRUD operations, Batch API, View storage, Error handling | 🟢 Active |
154+
| **[`@objectstack/client-react`](packages/client-react)** | React hooks for ObjectStack | useQuery, useMutation, usePagination, useInfiniteQuery | 🟢 Active |
154155

155156
### Plugin Packages
156157

157-
| Package | Description | Status |
158-
| :--- | :--- | :--- |
159-
| **[`@objectstack/driver-memory`](packages/plugins/driver-memory)** | In-memory driver (reference implementation) | 🟢 Active |
160-
| **[`@objectstack/plugin-hono-server`](packages/plugins/plugin-hono-server)** | HTTP server plugin (Hono-based) | 🟢 Active |
161-
| **[`@objectstack/plugin-msw`](packages/plugins/plugin-msw)** | Mock Service Worker plugin for testing | 🟢 Active |
158+
| Package | Description | Key Features | Status |
159+
| :--- | :--- | :--- | :--- |
160+
| **[`@objectstack/driver-memory`](packages/plugins/driver-memory)** | In-memory driver (reference implementation) | Zero dependencies, Perfect for testing, Fast in-memory storage | 🟢 Active |
161+
| **[`@objectstack/plugin-hono-server`](packages/plugins/plugin-hono-server)** | HTTP server plugin (Hono-based) | Universal runtime, Auto-discovery, API Registry integration | 🟢 Active |
162+
| **[`@objectstack/plugin-msw`](packages/plugins/plugin-msw)** | Mock Service Worker plugin for testing | Automatic API mocking, Browser & Node support | 🟢 Active |
162163

163164
### Tools
164165

165-
| Package | Description | Status |
166-
| :--- | :--- | :--- |
167-
| **[`@objectstack/cli`](packages/cli)** | Command-line interface and development tools | 🟢 Active |
168-
| **[`@objectstack/docs`](apps/docs)** | Documentation site (Fumadocs + Next.js) | 🟢 Active |
166+
| Package | Description | Key Features | Status |
167+
| :--- | :--- | :--- | :--- |
168+
| **[`@objectstack/cli`](packages/cli)** | Command-line interface and development tools | serve, dev, compile, doctor, create, test:run | 🟢 Active |
169+
| **[`@objectstack/docs`](apps/docs)** | Documentation site (Fumadocs + Next.js) | Interactive docs, API reference, Examples | 🟢 Active |
170+
171+
### Package Quick Links
172+
173+
**For Application Developers:**
174+
- Start here: [`@objectstack/client`](packages/client/README.md) - Official SDK
175+
- React apps: [`@objectstack/client-react`](packages/client-react/README.md) - React hooks
176+
- Development: [`@objectstack/cli`](packages/cli/README.md) - CLI tools
177+
178+
**For Protocol Developers:**
179+
- Protocols: [`@objectstack/spec`](packages/spec/README.md) - Schema definitions
180+
- Runtime: [`@objectstack/core`](packages/core/README.md) - Microkernel
181+
- Data layer: [`@objectstack/objectql`](packages/objectql/README.md) - Query engine
182+
183+
**For Plugin Developers:**
184+
- Runtime: [`@objectstack/runtime`](packages/runtime/README.md) - Plugin patterns
185+
- Types: [`@objectstack/types`](packages/types/README.md) - Shared interfaces
186+
- Examples:
187+
- [`@objectstack/driver-memory`](packages/plugins/driver-memory/README.md) - Driver reference
188+
- [`@objectstack/plugin-hono-server`](packages/plugins/plugin-hono-server/README.md) - Server plugin
169189

170190
### Examples
171191

0 commit comments

Comments
 (0)