Skip to content

Commit 040191f

Browse files
Copilothuangyiirene
andcommitted
Add hyperlinks to all packages in README architecture section
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 601286c commit 040191f

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,36 +34,36 @@ ObjectQL is organized as a Monorepo to ensure modularity and universal compatibi
3434

3535
| Package | Environment | Description |
3636
| :--- | :--- | :--- |
37-
| **`@objectql/types`** | Universal | **The Contract.** Pure TypeScript interfaces defining the protocol. |
38-
| **`@objectql/core`** | Universal | **The Engine.** The runtime logic, validation, and repository pattern. |
39-
| **`@objectql/platform-node`**| Node.js | Node.js platform utilities for file system integration, YAML loading, and plugin management. |
37+
| **[`@objectql/types`](./packages/foundation/types)** | Universal | **The Contract.** Pure TypeScript interfaces defining the protocol. |
38+
| **[`@objectql/core`](./packages/foundation/core)** | Universal | **The Engine.** The runtime logic, validation, and repository pattern. |
39+
| **[`@objectql/platform-node`](./packages/foundation/platform-node)**| Node.js | Node.js platform utilities for file system integration, YAML loading, and plugin management. |
4040

4141
### Driver Layer
4242

4343
| Package | Environment | Description |
4444
| :--- | :--- | :--- |
45-
| **`@objectql/driver-sql`** | Node.js | SQL database driver (PostgreSQL, MySQL, SQLite, SQL Server) via Knex. |
46-
| **`@objectql/driver-mongo`** | Node.js | MongoDB driver with native aggregation pipeline support. |
47-
| **`@objectql/driver-memory`** | Universal | **In-Memory Driver.** Zero dependencies, perfect for testing and browser apps. |
48-
| **`@objectql/driver-localstorage`** | Browser | **Browser Storage.** Persistent client-side storage using LocalStorage. |
49-
| **`@objectql/driver-fs`** | Node.js | File system driver with JSON file-based persistent storage. |
50-
| **`@objectql/driver-excel`** | Node.js | Excel file driver for using `.xlsx` spreadsheets as a data source. |
51-
| **`@objectql/driver-redis`** | Node.js | Redis driver (example/template implementation for key-value stores). |
52-
| **`@objectql/sdk`** | Universal | **Remote HTTP Driver.** Type-safe client for connecting to ObjectQL servers. |
45+
| **[`@objectql/driver-sql`](./packages/drivers/sql)** | Node.js | SQL database driver (PostgreSQL, MySQL, SQLite, SQL Server) via Knex. |
46+
| **[`@objectql/driver-mongo`](./packages/drivers/mongo)** | Node.js | MongoDB driver with native aggregation pipeline support. |
47+
| **[`@objectql/driver-memory`](./packages/drivers/memory)** | Universal | **In-Memory Driver.** Zero dependencies, perfect for testing and browser apps. |
48+
| **[`@objectql/driver-localstorage`](./packages/drivers/localstorage)** | Browser | **Browser Storage.** Persistent client-side storage using LocalStorage. |
49+
| **[`@objectql/driver-fs`](./packages/drivers/fs)** | Node.js | File system driver with JSON file-based persistent storage. |
50+
| **[`@objectql/driver-excel`](./packages/drivers/excel)** | Node.js | Excel file driver for using `.xlsx` spreadsheets as a data source. |
51+
| **[`@objectql/driver-redis`](./packages/drivers/redis)** | Node.js | Redis driver (example/template implementation for key-value stores). |
52+
| **[`@objectql/sdk`](./packages/drivers/sdk)** | Universal | **Remote HTTP Driver.** Type-safe client for connecting to ObjectQL servers. |
5353

5454
### Runtime Layer
5555

5656
| Package | Environment | Description |
5757
| :--- | :--- | :--- |
58-
| **`@objectql/server`** | Node.js | HTTP server adapter for Node.js, Express, Next.js with REST and metadata APIs. |
58+
| **[`@objectql/server`](./packages/runtime/server)** | Node.js | HTTP server adapter for Node.js, Express, Next.js with REST and metadata APIs. |
5959

6060
### Tools Layer
6161

6262
| Package | Environment | Description |
6363
| :--- | :--- | :--- |
64-
| **`@objectql/cli`** | Node.js | Command-line interface with AI-powered generation, dev server, and project management. |
65-
| **`@objectql/create`** | Node.js | Project scaffolding tool (`npm create @objectql@latest`). |
66-
| **`vscode-objectql`** | VS Code | Official VS Code extension with IntelliSense, validation, and snippets. |
64+
| **[`@objectql/cli`](./packages/tools/cli)** | Node.js | Command-line interface with AI-powered generation, dev server, and project management. |
65+
| **[`@objectql/create`](./packages/tools/create)** | Node.js | Project scaffolding tool (`npm create @objectql@latest`). |
66+
| **[`vscode-objectql`](./packages/tools/vscode-objectql)** | VS Code | Official VS Code extension with IntelliSense, validation, and snippets. |
6767

6868
---
6969

0 commit comments

Comments
 (0)