create-clivly 0.8.0 → 0.9.1

package/README.md

@@ -1,46 +1,102 @@
 # create-clivly
 
-Scaffold [Clivly](https://clivly.com) — an embeddable CRM — into your existing
+Scaffold [Clivly](https://clivly.com) — an embeddable CRM — into your **existing**
 app. This is the `create-*` entry point for `clivly init`: it runs exactly what
 `clivly init` runs, with the same flags, against a version-pinned `clivly`
 runtime.
 
+> `create-clivly` does **not** create a new application. It scaffolds Clivly
+> into a project you already have.
+
+## Prerequisites
+
+| Requirement | Version / note |
+| --- | --- |
+| Node.js | **≥ 22** |
+| An existing app | Next.js, TanStack Start, SvelteKit, Remix or Nuxt for route scaffolding |
+| Drizzle ORM | Required to generate a config. Prisma/Kysely projects hand-write a `fetchPage` source instead |
+
+## Installation
+
 ```bash
 npm create clivly
 # or
 npx create-clivly
 # or
 pnpm create clivly
+# or
+yarn create clivly
+# or
+bun create clivly
 ```
 
-Clivly's stable packages publish on npm's `latest` tag. Use `@next` only when
-you are intentionally validating a prerelease build.
+Published on npm's `latest` tag. Use `@next` only when you are deliberately
+validating a prerelease build.
+
+## What it writes
+
+| File | Owned by Clivly |
+| --- | --- |
+| `clivly.config.ts` | No — yours to edit |
+| The tick route for your framework | Yes — `--force` to overwrite |
+| The auth-verify route for your framework | Yes — `--force` to overwrite |
 
-It writes your `clivly.config.ts`, scaffolds the CRM routes, extends your
-Drizzle schema, and (unless `--no-login`) pairs this machine to your workspace.
+Plus `CLIVLY_SECRET_KEY`, `CLIVLY_SYNC_TRIGGER_URL` and
+`CLIVLY_SYNC_TRIGGER_SECRET` placeholders in your framework's env file
+(`.env.local` on Next.js, `.dev.vars` on Cloudflare Workers, `.env` elsewhere),
+and — unless `--no-login` — it pairs this machine with your workspace.
+
+It creates **no database tables** and does **not** modify your ORM schema.
+Clivly Cloud holds the CRM records; your own tables are only ever read.
 
 If you run it from a workspace root, it looks for a supported Drizzle app in
-that repo and scaffolds there. If it finds more than one, it stops and shows
-you the candidate directories instead of guessing.
+that repo and scaffolds there. If it finds more than one, it stops and shows you
+the candidate directories instead of guessing.
 
 ## Flags
 
-These are forwarded straight to `clivly init`:
+Forwarded straight to `clivly init` — this is the full set.
 
 | Flag | Effect |
 | --- | --- |
-| `--dry-run` | Print the plan and the diff without writing anything |
-| `--force` | Overwrite existing files / `.env` values |
-| `--schema <path>` | Point at your Drizzle schema explicitly |
+| `--dry-run` | Print the plan without writing anything |
+| `--diff` | Show a diff for files that already exist |
+| `--force` | Overwrite the files Clivly owns, and env values that already have a real value |
+| `--yes` | Skip prompts |
 | `--no-login` | Skip the browser pairing step |
-| `--no-browser` | Don't auto-open the approval URL |
+| `--no-browser` | Pair, but print the approval URL instead of opening it |
+| `--schema <path\|package>` | Point at your Drizzle schema explicitly |
+| `--db-import <specifier>` | Where the Drizzle instance lives, when it is not beside the schema. Accepts `@acme/database#database` |
+| `--auth-import <specifier>` | Where your better-auth instance lives. Same `#exportName` form |
+| `--contact-table <name>` | Use this table as the contact entity, skipping the heuristics |
+| `--company-table <name>` | Same for companies |
+
+Full explanations of each flag, plus monorepo behaviour and what happens when no
+contact entity can be found, are in the
+[`clivly` CLI README](https://github.com/amani-joseph/clivly.com/blob/master/packages/cli/README.md#clivly-init).
+
+## Verify
+
+```bash
+npx clivly status
+```
 
 ## Relationship to `clivly`
 
 - **`create-clivly`** — the scaffolder you run once to set a project up.
-- **`clivly`** — the runtime you import (`import { createClivlySDK } from "clivly/sdk"`) and the CLI you run afterwards (`clivly status`, `clivly dev`, `clivly login`).
+- **`clivly`** — the runtime you import
+  (`import { createClivlySDK } from "clivly/sdk"`) and the CLI you run afterwards
+  (`clivly status`, `clivly dev`, `clivly login`, `clivly add widget`).
 
 `create-clivly` pins the `clivly` version it installs, so the scaffolder and the
 runtime never drift.
 
-MIT licensed.
+## Related documentation
+
+- **[Connecting to Clivly Cloud](https://github.com/amani-joseph/clivly.com/blob/master/docs/guides/connecting-to-clivly-cloud.md)** — the canonical end-to-end guide
+- [`clivly` CLI README](https://github.com/amani-joseph/clivly.com/blob/master/packages/cli/README.md)
+- [`@clivly/sdk` README](https://github.com/amani-joseph/clivly.com/blob/master/packages/sdk/README.md)
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-clivly",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "private": false,
   "type": "module",
   "description": "Scaffold Clivly into your app — the create-* entry point for `clivly init`.",
@@ -34,7 +34,7 @@
     }
   },
   "dependencies": {
-    "clivly": "0.8.0"
+    "clivly": "0.9.1"
   },
   "author": "Joseph Amani",
   "engines": {