prisma-pglite-bridge 0.7.0 → 1.0.0

package/README.md

@@ -18,15 +18,15 @@ TypeScript users also need `@types/pg`.
 ## Quickstart
 
 ```typescript
-import { PGlite } from '@electric-sql/pglite';
-import { createPGliteBridge, pushMigrations } from 'prisma-pglite-bridge';
+import { PGliteBridge, pushMigrations } from 'prisma-pglite-bridge';
 import { PrismaClient } from '@prisma/client';
 import seed from './seed.ts'; // user-provided: (prisma: PrismaClient) => Promise<void>
 
-const pglite = new PGlite();
-await pushMigrations(pglite, { migrationsPath: './prisma/migrations' });
+const bridge = new PGliteBridge();
+// Have prisma/migrations/? Use pushMigrations (shown).
+// Only schema.prisma? Use pushSchema instead — see docs/api.md.
+await pushMigrations(bridge.pglite, { migrationsPath: './prisma/migrations' });
 
-const bridge = await createPGliteBridge({ pglite });
 const prisma = new PrismaClient({ adapter: bridge.adapter });
 await seed(prisma);
 await bridge.snapshotDb();
@@ -49,6 +49,10 @@ fixtures, prototypes), see [Populating the
 database](./docs/api.md#populating-the-database) for the
 `pushSchema` alternative.
 
+Running the Prisma CLI against this bridge (shadow DB for
+`migrate dev`, `psql`, SQL GUIs)? See
+[`PGliteServer`](./docs/server.md) for the TCP/Unix-socket front.
+
 ## Documentation
 
 - **[API reference](./docs/api.md)** — exports, options, return