diff --git a/.changeset/document-node-runtime.md b/.changeset/document-node-runtime.md new file mode 100644 index 000000000..57a3848ad --- /dev/null +++ b/.changeset/document-node-runtime.md @@ -0,0 +1,7 @@ +--- +'@gpuix/react': patch +--- + +Document existing Node.js runtime support and distinguish Bun's hot-remount development workflow from normal app startup. + +Fixes #84 diff --git a/README.md b/README.md index fa1f109bb..ac02e031e 100644 --- a/README.md +++ b/README.md @@ -108,8 +108,14 @@ render(, { title: 'My App', width: 800, height: 600 }) bun --hot app.tsx ``` -Use `bun --hot`, not plain `bun`. A save then remounts React on the same -window instead of opening a second one. +For hot reload during development, use `bun --hot` rather than plain `bun`. +A save then remounts React on the same window instead of opening a second one. + +Bun is not required to run the renderer. GPUIX uses Node-API native bindings, +and React apps also run on Node.js, as [`disktree`](./disktree/) does. For +Node.js, compile TSX to JavaScript first or use a Node-compatible TSX loader. +The `--hot` option and same-window hot-remount workflow described below are +Bun-specific; running an app on Node.js does not provide Bun's hot reload. ### 4. Ship a binary