Skip to content

Commit 7397bd9

Browse files
authored
Merge pull request #533 from powersync-ja/benitav-patch-1
Update README.md
2 parents fba3dad + 7c118b6 commit 7397bd9

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

.changeset/yellow-countries-warn.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@powersync/node': patch
3+
---
4+
5+
Update readme to refer to Node.js docs

packages/node/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ _[PowerSync](https://www.powersync.com) is a sync engine for building local-firs
99
This package (`packages/node`) is the PowerSync SDK for Node.js clients. It is an extension of `packages/common`.
1010
Using this package is not necessary for PowerSync on servers, see [our documentation](https://docs.powersync.com/installation/app-backend-setup) for more details on that.
1111

12-
This package has an API similar to the PowerSync web SDK, for which a summary of features is available [here](https://docs.powersync.com/client-sdk-references/js-web).
12+
See a summary of features [here](https://docs.powersync.com/client-sdk-references/node).
1313

1414
## Alpha Release
1515

@@ -28,9 +28,8 @@ or download sqlite3 and PowerSync binaries.
2828

2929
# Getting Started
3030

31-
You can follow along our [web SDK reference](https://docs.powersync.com/client-sdk-references/js-web)
32-
which contains everything you need to know to get started implementing PowerSync in your project.
33-
Replace imports of `@powersync/web` with `@powersync/node` where necessary.
31+
The [Node.js SDK reference](https://docs.powersync.com/client-sdk-references/node)
32+
contains everything you need to know to get started implementing PowerSync in your project.
3433

3534
# Examples
3635

0 commit comments

Comments
 (0)