diff --git a/README.md b/README.md index 6f2e8c4..6f3f7a5 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,15 @@ import { MetalKnob, LEDKnob, Fader, logTaper } from 'dreamknob' See `packages/dreamknob/README.md` and the docs app for the full API. -## Using it in another app (without publishing) +## Using it in another app -The package builds to `packages/dreamknob/dist` (ESM + CJS + types). Three options: +The easiest way is the published release on our Forgejo: + +```bash +pnpm add https://git.dreamodus.software/Dreamodus/DreamKnob/releases/download/v1.0.0/dreamknob-1.0.0.tgz +``` + +Or build locally — the package builds to `packages/dreamknob/dist` (ESM + CJS + types): ```bash # 1. Tarball (most robust — behaves exactly like an npm install) diff --git a/apps/docs/src/sections/GettingStarted.tsx b/apps/docs/src/sections/GettingStarted.tsx index 27edaee..15c53da 100644 --- a/apps/docs/src/sections/GettingStarted.tsx +++ b/apps/docs/src/sections/GettingStarted.tsx @@ -29,10 +29,16 @@ export const GettingStarted: React.FC = () => (

- = 18, react-dom >= 18`} /> + ) · peer deps: react >= 18, react-dom >= 18`} + />

- Zero runtime dependencies, ESM + CJS, full TypeScript types. No CSS file to - import — everything is SVG and inline styles. + Installs straight from the{' '} + + v1.0.0 release + {' '} + on our Forgejo. Zero runtime dependencies, ESM + CJS, full TypeScript types. No + CSS file to import — everything is SVG and inline styles.

diff --git a/apps/docs/src/sections/Hero.tsx b/apps/docs/src/sections/Hero.tsx index 84cc66a..f1a37a0 100644 --- a/apps/docs/src/sections/Hero.tsx +++ b/apps/docs/src/sections/Hero.tsx @@ -25,10 +25,10 @@ export const Hero: React.FC = () => { range, any decimal precision, and colors you fully control.

- pnpm add dreamknob + pnpm add https://git.dreamodus.software/Dreamodus/DreamKnob/releases/download/v1.0.0/dreamknob-1.0.0.tgz