diff --git a/README.md b/README.md index db4303c01..c3f4a9c41 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ Demo applications are located in the [`demos/`](./demos/) directory. Also see ou ### Electron - [demos/example-electron](./demos/example-electron/README.md) An Electron example web rendered app using the PowerSync Web SDK in the renderer process. -- [demos/example-electron-node](./demos/example-electron-node/README.md) An Electron example using a PowerSync database in the main process. +- [demos/example-electron-node](./demos/example-electron-node/README.md) An Electron example that runs PowerSync in the main process using the PowerSync Node.js SDK. ### Capacitor diff --git a/demos/example-electron-node/README.md b/demos/example-electron-node/README.md index cf4367c10..d8d0d710e 100644 --- a/demos/example-electron-node/README.md +++ b/demos/example-electron-node/README.md @@ -1,6 +1,6 @@ # PowerSync + Electron in main process -This example shows how the [PowerSync Node.js client](https://docs.powersync.com/client-sdk-references/node) can be used in the main process of an Electron app. +This example shows how the [PowerSync Node.js client SDK](https://docs.powersync.com/client-sdk-references/node) can be used in the main process of an Electron app. The purpose of this example is to highlight specific build configurations that enable this setup. In particular: diff --git a/demos/example-node/README.md b/demos/example-node/README.md index 85b16e181..47af6f8c3 100644 --- a/demos/example-node/README.md +++ b/demos/example-node/README.md @@ -1,6 +1,6 @@ -## Node.js Demo +## Node.js CLI Demo -This demonstrates a small Node.js client opening a database and connecting PowerSync. +This demonstrates a small Node.js CLI client opening a database, connecting PowerSync and running live queries. This demo is configured to talk to an example backend [you can host yourself](https://github.com/powersync-ja/self-host-demo). To get started: @@ -14,3 +14,7 @@ Results from the query are printed every time it changes. Try: 1. Updating a row in the backend database and see changes reflected in the running client. 2. Enter `add('my list')` and see the new list show up in the backend database. + +For more details, see the documentation for [the PowerSync node package](https://docs.powersync.com/client-sdk-references/node) and check other examples: + +- [example-electron-node](../example-electron-node/): An Electron example that runs PowerSync in the main process using the Node.js SDK.