@shophost/rest-api 2.0.24 → 2.0.26

package/README.md

@@ -44,12 +44,16 @@ import { ManufacturerSchema } from "@shophost/rest-api/schemas";
 
 ## Database Schema Sync
 
-The published package now includes a small CLI so a fresh project can push the packaged Prisma schema to its own database.
+The published package includes a CLI so a fresh project can push the packaged Prisma schema to its own database without copying `schema.prisma` into the app.
 
-1. Set one of these environment variables in your app shell, `.env`, or `.env.local`:
-   - `DATABASE_URL`
+1. Add your database URL to one of these places in the consuming app:
+   - `.env.local`
+   - `.env`
+   - the shell environment
+2. Use one of these variables:
    - `POSTGRES_PRISMA_URL`
-2. Run:
+   - `DATABASE_URL`
+3. Run:
 
 ```bash
 pnpm exec shophost-rest-api db push
@@ -57,14 +61,25 @@ pnpm exec shophost-rest-api db push
 npx shophost-rest-api db push
 ```
 
+Example:
+
+```env
+# .env.local
+POSTGRES_PRISMA_URL=postgresql://user:password@host:5432/dbname?sslmode=require
+```
+
 You can pass regular Prisma `db push` flags through as well:
 
 ```bash
 pnpm exec shophost-rest-api db push --accept-data-loss
-pnpm exec shophost-rest-api db push --url "postgres://..."
+pnpm exec shophost-rest-api db push --url "postgresql://user:password@host:5432/dbname?sslmode=require"
 ```
 
-The CLI uses the `schema.prisma` and `prisma.config.ts` that ship with `@shophost/rest-api`, so consumers do not need to copy the schema into their own project first.
+Notes:
+
+- `.env.local` overrides `.env`
+- `POSTGRES_PRISMA_URL` takes precedence over `DATABASE_URL`
+- the CLI uses the `schema.prisma` and `prisma.config.ts` shipped inside `@shophost/rest-api`
 
 ## Development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shophost/rest-api",
-  "version": "2.0.24",
+  "version": "2.0.26",
   "type": "module",
   "bin": {
     "shophost-rest-api": "./scripts/shophost-rest-api.mjs"