diff --git a/docs-app/src/templates/install/index.gjs.md b/docs-app/src/templates/install/index.gjs.md index 8ceab3d0..82903023 100644 --- a/docs-app/src/templates/install/index.gjs.md +++ b/docs-app/src/templates/install/index.gjs.md @@ -28,6 +28,31 @@ pnpm add kolay [^type-module]: this library sets `type: module` in its `package.json`, which for ember projects means that it requires vite. +
+Trying unreleased changes (the dist branch) + +Every push to `main` publishes the built package contents to the [`dist` branch](https://github.com/universal-ember/kolay/tree/dist), so unreleased changes can be tried without waiting for a release: + +```bash +pnpm add kolay@github:universal-ember/kolay#dist +``` + +In a workspace where other packages also depend on `kolay` (or to keep your declared semver range untouched), use an override instead, in the root `package.json`: + +```jsonc +{ + "pnpm": { + "overrides": { + "kolay": "github:universal-ember/kolay#dist", + }, + }, +} +``` + +The install resolves the branch to its current commit and pins that in your lockfile — to pick up newer changes later, run `pnpm update kolay` (or re-run the install after removing the lockfile entry). + +
+ ### Use Markdown - from any folder, any project (good for monorepos)