@repost/client 0.2.0 → 0.4.0

package/README.md

@@ -1,93 +1,23 @@
 # @repost/client
 
-The npm face of the Repost-generated webhooks SDK, split exactly like Prisma's
-`@prisma/client`:
+[![npm version](https://img.shields.io/npm/v/@repost/client.svg)](https://www.npmjs.com/package/@repost/client)
 
-- **The entry stub** (`index.js` / `index.mjs` / `index.d.ts` at the package
-  root) re-exports the *generated* client from the sibling `.repost/client`
-  package that `repost schema generate` writes into `node_modules`. Consumers
-  write:
+Type-safe webhook publishing generated from your Repost schema. `@repost/client`
+exposes the models, enums, and webhook methods generated by the Repost CLI, then
+handles deterministic serialization, Standard Webhooks envelopes, idempotency,
+retries, and publishing — so a send is a single typed method call.
 
-  ```ts
-  import { createRepostClient, type User } from "@repost/client";
-  ```
+It is part of the [Repost](https://repost.sh) platform for defining webhook
+contracts once and delivering them reliably. See the full documentation at
+[repost.sh/docs](https://repost.sh/docs).
 
-  Before the first generate, the postinstall-written placeholder throws
-  `@repost/client did not initialize yet. Please run "repost schema generate"`.
+## Getting started
 
-- **The runtime** (`@repost/client/runtime`, built into `dist/`) carries the
-  logic the generated code depends on: schema-driven serialization (`@map`
-  renames, `@default` injection), Standard Webhooks envelope construction, and
-  the transport (a no-network stub until workstream A). Generated code imports
-  it by subpath:
+- [Quickstart](https://repost.sh/docs/send/typescript/quickstart) (5 min)
+- [Schema & migrations](https://repost.sh/docs/send/typescript/generation) (15 min)
+- [Add Repost to an existing project](https://repost.sh/docs/send/typescript/existing-project) (15 min)
 
-  ```ts
-  import { buildWebhooks, type ModelDescriptor } from "@repost/client/runtime";
-  ```
+## Support
 
-Monorepos that set a custom `output` in their generator block import the
-generated package by path instead; the stub goes unused, the runtime subpath
-still serves them.
-
-## Layout
-
-| Path | Role |
-|------|------|
-| `index.js` / `index.mjs` / `index.d.ts` | Static stubs re-exporting `.repost/client/default` (the `@prisma/client` pattern — a single static spread, so `cjs-module-lexer` carries named exports into ESM). |
-| `scripts/postinstall.js` | Writes the friendly-error placeholder `.repost/client` when nothing is generated yet. Never clobbers a real client; silent no-op outside `node_modules`. |
-| `src/` → `dist/` (rollup) | The runtime, exported as `@repost/client/runtime`. |
-| `tests/generated/` | The canonical generated package fixture, byte-identical to the Rust emitter (enforced by `canonical_generated_sdk_js_fixture_is_in_sync`; refresh with `UPDATE_EXPECT=1 cargo test -p repost-schema`). |
-| `tests/stub-resolution.test.ts` | Real-`node` proof of the stub chain under npm and pnpm layouts, plus the before-generate error. |
-| `tests/prisma-parity.test.ts` | Runs real `prisma generate` side by side and asserts the shared structural invariants (packaging spec R10). |
-| `tests/e2e-session.test.ts` | The full consumer flow — `init` → multi-file schema → install → `migrate dev` → typed imports — against the real engine binary. |
-
-## Local development
-
-`@repost/client` is not published to npm yet (see below). Until it is, consumers
-outside this monorepo can wire it up locally. The options are listed in order of
-fidelity — the first is truest to a real install, the last is fastest to iterate.
-
-### 1. Pack and install the tarball (recommended)
-
-This exercises the exact `files` and `exports` a published package would ship,
-so it catches a missing `dist/` file or a broken export before your users do.
-
-```bash
-# in this package
-pnpm pack                       # writes repost-client-0.1.0.tgz (prepack builds dist/ first)
-
-# in your consumer app
-npm install ../path/to/repost-client-0.1.0.tgz
-repost schema generate          # writes node_modules/.repost/client
-```
-
-`pnpm pack` runs the `prepack` script, so the tarball always contains a fresh
-`dist/`. Re-run `pnpm pack` and reinstall after each change you want to test.
-Remember to re-run `repost schema generate` after any reinstall that prunes
-`node_modules`.
-
-### 2. Link a built checkout (fastest iteration)
-
-Linking is quicker but only resolves what is on disk under `dist/`, so you must
-build first — an unbuilt checkout resolves to nothing.
-
-```bash
-# in this package
-pnpm build            # or: pnpm dev  (rollup -c -w, rebuilds dist/ on every save)
-pnpm link --global    # or: npm link
-
-# in your consumer app
-pnpm link --global @repost/client   # or: npm link @repost/client
-```
-
-Run `pnpm dev` in a separate terminal to keep `dist/` rebuilding while you edit,
-and the linked consumer picks up each rebuild.
-
-### 3. After npm publish
-
-Publishing is pending license confirmation. Once `@repost/client` is on npm this
-whole section collapses to:
-
-```bash
-npm install @repost/client
-```
+- [GitHub repository](https://github.com/repost-sh/monorepo)
+- [Documentation](https://repost.sh/docs)