@kanjijs/store 0.2.0-beta.1

package/README.md

@@ -0,0 +1,57 @@
+# @kanjijs/store
+
+Database integration module for Kanjijs Framework.
+
+Currently supports **Postgres** (via `postgres.js` driver) and integrates seamlessly with **Drizzle ORM**.
+
+## Installation
+
+```bash
+bun add @kanjijs/store drizzle-orm postgres
+```
+
+## Usage
+
+### 1. Register the Module
+Import `StoreModule` in your root `AppModule`.
+
+```typescript
+// app.module.ts
+import { Module } from "@kanjijs/core";
+import { StoreModule } from "@kanjijs/store";
+import * as schema from "./db/schema"; // Drizzle Schema
+
+@Module({
+  imports: [
+    StoreModule.forRoot({
+      url: process.env.DATABASE_URL!,
+      schema: schema
+    })
+  ]
+})
+export class AppModule {}
+```
+
+### 2. Inject the Database Client
+Use the `@InjectDb()` decorator to inject the Drizzle client into your services.
+
+```typescript
+// users.service.ts
+import { Injectable } from "@kanjijs/core";
+import { InjectDb, type DrizzleDb } from "@kanjijs/store";
+import { users } from "./db/schema";
+
+@Injectable()
+export class UserService {
+  constructor(@InjectDb() private db: DrizzleDb) {}
+
+  async findAll() {
+    // Full Type-Safety & Auto-Completion
+    return await this.db.select().from(users);
+  }
+}
+```
+
+## Extensibility
+
+While this package defaults to Postgres/Drizzle, the dependency injection pattern (`DATABASE_CLIENT` token) allows you to swap this for other providers (e.g., Mongo, SQLite) by implementing your own dynamic module if needed.