Skip to content

Commit d70f5ad

Browse files
committed
docs: soften v0.6.2 release notes — framed as care for pnpm/yarn/bun users
Rewrites the 'Using pnpm, yarn, or bun' section so the rationale leads with "we fit your toolchain and don't want you hit by an npm 12 cliff" instead of a dry technical warning. Content unchanged, tone only.
1 parent c620154 commit d70f5ad

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,17 @@ Then start a Claude Code session. Watch it pick Sonnet for your next grep — an
165165

166166
### Using pnpm, yarn, or bun
167167

168+
better-model fits whichever package manager your project already uses:
169+
168170
```bash
169171
pnpm dlx better-model@latest init # pnpm
170172
yarn dlx better-model@latest init # yarn berry
171173
bunx better-model@latest init # bun
172174
```
173175

174-
If your project has a `.npmrc` with pnpm-specific keys (`node-linker`, `auto-install-peers`, `strict-peer-dependencies`, `enable-pre-post-scripts`), running via `npx` will produce [npm warnings](https://github.com/npm/cli/issues/8153) that will become hard errors in npm 12. `pnpm dlx` / `yarn dlx` / `bunx` route through the matching manager instead, which understands those keys. For a permanent fix, [move the keys into `pnpm-workspace.yaml`](https://pnpm.io/settings) in camelCase (e.g. `nodeLinker: isolated`) and keep only auth/registry settings in `.npmrc`.
176+
If you run `npx better-model init` inside a pnpm, yarn, or bun project, better-model notices your lockfile or `packageManager` field and prints a one-line tip with the native command — so your next run stays quiet and fits into your existing toolchain. No hint appears in plain npm projects; you only see it when it's actually useful.
175177

176-
When `init` runs in a pnpm/yarn/bun project, better-model prints this reminder automatically.
178+
**Why we went out of our way for this.** Many pnpm projects keep pnpm-only keys in `.npmrc``node-linker`, `auto-install-peers`, `strict-peer-dependencies`, `enable-pre-post-scripts`. npm 11 already prints "Unknown project config" warnings for those, and [npm 12 will refuse to start](https://github.com/npm/cli/issues/8153). We didn't want you to discover that the hard way through a cryptic `npx better-model` failure six months from now. Running through `pnpm dlx` / `yarn dlx` / `bunx` sidesteps the warnings today; the canonical long-term fix is to [move those keys into `pnpm-workspace.yaml`](https://pnpm.io/settings) in camelCase (`nodeLinker: isolated`, `autoInstallPeers: true`, …) and keep `.npmrc` for auth and registry only.
177179

178180
### Upgrading from v0.5.x
179181

0 commit comments

Comments
 (0)