@adaptware/eagles-db 0.4.17 → 0.4.19

package/README.md

@@ -1,110 +1,15 @@
-# Treadspace DB
+# @adaptware/eagles-db
 
-A Prisma client package for Treadspace database operations.
+Prisma schema and client for the Treadspace hiring database.
 
-## Installation
+**Package name:** `@adaptware/eagles-db`  
+**CLI binary:** `treadspace-db` (see [docs/eagles-db/cli-reference.md](./docs/eagles-db/cli-reference.md))
 
-```bash
-npm install treadspace-db
-```
-
-## Usage
-
-### Basic Usage
-
-```typescript
-import { prisma } from "treadspace-db";
-
-// Use the prisma client
-const users = await prisma.user.findMany();
-```
-
-### With TypeScript
-
-```typescript
-import { prisma, PrismaClient } from "treadspace-db";
-
-// The prisma instance is already configured and ready to use
-const user = await prisma.user.create({
-  data: {
-    email: "user@example.com",
-    name: "John Doe",
-  },
-});
-```
-
-## Environment Setup
-
-Make sure to set your `DATABASE_URL` environment variable:
-
-```bash
-DATABASE_URL="postgresql://username:password@localhost:5432/database_name"
-```
-
-## Development
-
-### Prerequisites
-
-- Node.js 16+
-- PostgreSQL database
-
-### Setup
-
-1. Install dependencies:
-
-```bash
-npm install
-```
-
-2. Set up your database URL in `.env`:
-
-```bash
-DATABASE_URL="postgresql://username:password@localhost:5432/database_name"
-```
-
-3. Add your database models to `prisma/schema.prisma`
-
-4. Generate Prisma client:
-
-```bash
-npm run generate
-```
-
-5. Push schema to database:
+**Local documentation:** [docs/README.md](./docs/README.md)  
+**Central monorepo hub:** [docs/README.md](../docs/README.md)
 
 ```bash
-npm run db:push
+yarn install
+export DATABASE_URL=postgresql://...
+yarn generate
 ```
-
-### Available Scripts
-
-- `npm run build` - Build the TypeScript code
-- `npm run dev` - Watch mode for development
-- `npm run generate` - Generate Prisma client
-- `npm run db:push` - Push schema changes to database
-- `npm run db:migrate` - Create and apply migrations
-- `npm run db:studio` - Open Prisma Studio
-
-## Adding Tables
-
-To add tables to your database:
-
-1. Edit `prisma/schema.prisma` and add your models
-2. Run `npm run generate` to update the Prisma client
-3. Run `npm run db:push` to apply changes to your database
-
-Example model:
-
-```prisma
-model User {
-  id        Int      @id @default(autoincrement())
-  email     String   @unique
-  name      String?
-  createdAt DateTime @default(now())
-  updatedAt DateTime @updatedAt
-}
-```
-
-## License
-
-MIT