Skip to content

Commit 610df23

Browse files
committed
Readme polishes
1 parent f8fd814 commit 610df23

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Demo applications are located in the [`demos/`](./demos/) directory. Also see ou
8080
### Electron
8181

8282
- [demos/example-electron](./demos/example-electron/README.md) An Electron example web rendered app using the PowerSync Web SDK in the renderer process.
83-
- [demos/example-electron-node](./demos/example-electron-node/README.md) An Electron example using a PowerSync database in the main process.
83+
- [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.
8484

8585
### Capacitor
8686

demos/example-electron-node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PowerSync + Electron in main process
22

3-
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.
3+
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.
44

55
The purpose of this example is to highlight specific build configurations that enable this setup.
66
In particular:

demos/example-node/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Node.js Demo
1+
## Node.js CLI Demo
22

3-
This demonstrates a small Node.js client opening a database and connecting PowerSync.
3+
This demonstrates a small Node.js CLI client opening a database, connecting PowerSync and running live queries.
44

55
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:
66

@@ -14,3 +14,7 @@ Results from the query are printed every time it changes. Try:
1414

1515
1. Updating a row in the backend database and see changes reflected in the running client.
1616
2. Enter `add('my list')` and see the new list show up in the backend database.
17+
18+
For more details, see the documentation for [the PowerSync node package](https://docs.powersync.com/client-sdk-references/node) and check other examples:
19+
20+
- [example-electron-node](../example-electron-node/): An Electron example that runs PowerSync in the main process using the Node.js SDK.

0 commit comments

Comments
 (0)