Release 1.0.0: license, changelog, packaging closeout

- MIT license attributed to Dreamodus Software Inc. (root + package
  LICENSE, package.json author, README and docs-site footer)
- Version 1.0.0; CHANGELOG.md summarizing the release
- Package files whitelist includes LICENSE/README/CHANGELOG; tarballs
  gitignored
- Root README: instructions for consuming the unpublished package
  (tarball, file dependency, or pnpm link)

Verified: 32 tests, both packages typecheck, production builds clean,
and a pnpm-pack tarball installed into a fresh project resolves all 50
exports via both ESM and CJS.
This commit is contained in:
Dreamodus 2026-07-12 21:05:34 -07:00
parent 68777fd00e
commit 54d006b137
8 changed files with 113 additions and 4 deletions

View file

@ -42,3 +42,27 @@ import { MetalKnob, LEDKnob, Fader, logTaper } from 'dreamknob'
`useKnob`.
See `packages/dreamknob/README.md` and the docs app for the full API.
## Using it in another app (without publishing)
The package builds to `packages/dreamknob/dist` (ESM + CJS + types). Three options:
```bash
# 1. Tarball (most robust — behaves exactly like an npm install)
cd packages/dreamknob && pnpm build && pnpm pack
# then in your app:
pnpm add /path/to/dreamknob-1.0.0.tgz
# 2. File dependency (picks up rebuilds on reinstall)
pnpm add file:../dreamknob/packages/dreamknob
# 3. Link for active development against your app
cd packages/dreamknob && pnpm link --global
cd your-app && pnpm link --global dreamknob
```
Peer deps: `react >= 18`, `react-dom >= 18`. No CSS import needed.
## License
MIT © Dreamodus Software Inc. — see [LICENSE](LICENSE).