@livepeer/design-system 1.1.1 → 1.1.2

package/README.md

@@ -8,10 +8,50 @@ Visit [https://livepeer-design-system.vercel.app/](https://livepeer-design-syste
 
 ## Usage
 
-```
+```bash
 yarn add @livepeer/design-system
 ```
 
-## License
+## Local development
+
+### Running the docs site
+
+```bash
+yarn install
+yarn dev        # docs site at http://localhost:3000
+```
+
+### Testing changes in consumer apps
+
+The design system is consumed by apps such as the [Livepeer Explorer](https://github.com/livepeer/explorer). Use [yalc](https://github.com/wclr/yalc) to test local changes against one or more consumers before publishing — it copies files into each consumer's `node_modules` rather than symlinking, which avoids the duplicate React instance / "Invalid hook call" errors you get from `pnpm link` or `yarn link`.
+
+```bash
+# one-time install
+npm i -g yalc
+
+# first-time publish from design-system (populates ~/.yalc/packages)
+yarn ds:build
+yalc publish
+
+# one-time, in each consumer app
+yalc add @livepeer/design-system
+pnpm install    # or yarn install
+
+# in design-system, after each change
+yarn ds:build && yalc push
+```
+
+`yalc publish` puts the package in your local yalc store so consumers can `yalc add` it. `yalc push` rebuilds the store entry *and* propagates the new build to every consumer that has already added it. To unlink: run `yalc remove @livepeer/design-system` in each consumer and restore the original dependency version.
+
+For a faster dev loop, run rollup in watch mode and push manually when you want to test:
+
+```bash
+# terminal 1: rebuild on save
+rollup -c -w
+
+# terminal 2: sync to consumers
+yalc push
+```
 
-Licensed under the [MIT](./LICENSE) license.
+> [!TIP]
+> Next.js sometimes ignores changes inside `node_modules`. If HMR doesn't fire after `yalc push`, touch a source file in the consumer app or restart its dev server.