create-kywi-app 0.2.1 → 0.3.1

package/README.md

@@ -100,47 +100,43 @@ The generated project's own `README.md` walks through `createdb`, copying
 `decoupled` deployment it also shows the `@kywi-software/sdk` usage snippet (see
 `packages/sdk/README.md` in this monorepo for the current, verified SDK API).
 
-## Using an unpublished checkout (local packages)
+## Installing the generated packages
 
-The `@kywi-software/*` packages are not published to npm yet, so the generated
-`package.json` refs (`"@kywi-software/core": "^0.1.0"`, etc.) will not install
-as-is. To scaffold against a **local checkout of this monorepo**, point those two
-deps at your built local packages before `pnpm install`.
+All `@kywi-software/*` packages (`core`, `cli`, `sdk`, `mcp`, `js`) are
+published to npm at the same version as `create-kywi-app`. The `package.json`
+this tool writes pins `"@kywi-software/core"` and `"@kywi-software/cli"` to
+`^<that version>` (see `buildFileSet()` in `lib/templates.mjs`), so a plain
 
-The most reliable way (mirrors a real npm install — dist-only, deduped React) is
-to pack the packages and reference the tarballs:
+```bash
+cd my-site && pnpm install   # (or npm install / yarn)
+```
+
+resolves them straight from the registry — no local build, packing, or
+override step required.
+
+### Working against a local monorepo checkout instead
+
+If you're developing `@kywi-software/*` itself and want a scaffolded app to
+pick up **unreleased** local changes rather than the published npm packages,
+build and pack the packages you changed, then repoint those two deps at the
+tarballs in the generated `package.json` (mirrors a real npm install —
+dist-only, deduped React — better than a `file:` link to the source directory,
+which risks a duplicate React copy):
 
 ```bash
-# 1. From the monorepo, build + pack core and cli
 pnpm --filter @kywi-software/core --filter @kywi-software/cli build
 ( cd packages/core && pnpm pack --pack-destination /tmp/kywi-pkgs )
 ( cd packages/cli  && pnpm pack --pack-destination /tmp/kywi-pkgs )
-
-# 2. Scaffold your app
 node packages/create-kywi-app/bin/create-kywi-app.mjs my-site --yes
-
-# 3. Repoint the two @kywi-software deps at the tarballs in my-site/package.json,
-#    AND add a pnpm override so cli's own core dependency resolves to the tarball:
-#    "dependencies": {
-#      "@kywi-software/core": "file:/tmp/kywi-pkgs/kywi-software-core-0.1.0.tgz",
-#      "@kywi-software/cli":  "file:/tmp/kywi-pkgs/kywi-software-cli-0.1.0.tgz"
-#    },
-#    "pnpm": {
-#      "overrides": {
-#        "@kywi-software/core": "file:/tmp/kywi-pkgs/kywi-software-core-0.1.0.tgz",
-#        "@kywi-software/cli":  "file:/tmp/kywi-pkgs/kywi-software-cli-0.1.0.tgz"
-#      }
-#    }
-
-# 4. Then the normal flow works unchanged
-cd my-site && pnpm install && createdb my_site && cp .env.example .env
+cd my-site
+#   Repoint "@kywi-software/core"/"@kywi-software/cli" in package.json at
+#   file:/tmp/kywi-pkgs/kywi-software-{core,cli}-<version>.tgz, then:
+pnpm install && createdb my_site && cp .env.example .env
 #   (set DATABASE_URL + AUTH_SECRET in .env)
 pnpm migrate && pnpm seed && pnpm dev
 ```
 
-`file:` to a directory (`file:../kywi/packages/core`) also works but risks a
-duplicate React copy through the symlink; tarballs avoid that. Re-pack after any
-change to core/cli and re-run `pnpm install`.
+Re-pack after any change to core/cli and re-run `pnpm install`.
 
 ## Testing