@coinlist-co/react 0.10.1 → 0.11.1-rc.10770e8

package/README.md

@@ -5,3 +5,35 @@ This package is documented at:
 https://docs.coinlist.co/
 
 Please refer to the docs site for installation, configuration, and integration guides.
+
+## Local development
+
+The toolchain (Node 24, TypeScript) is pinned by `flake.nix` and frozen by `flake.lock`.
+
+Prerequisites:
+
+1. Nix — install with the [Determinate Systems installer](https://github.com/DeterminateSystems/nix-installer),
+   which enables flakes out of the box and supports clean uninstalls:
+
+   ```bash
+   curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
+   ```
+
+2. [direnv](https://direnv.net/) and [nix-direnv](https://github.com/nix-community/nix-direnv)
+   (direnv on its own does not provide `use flake`).
+
+```bash
+direnv allow   # activates the dev shell on every cd into the repo
+```
+
+Without direnv, enter the same shell manually:
+
+```bash
+nix develop
+```
+
+The flake provides the toolchain, not `node_modules` — install JS dependencies as usual:
+
+```bash
+npm ci
+```