diff --git a/.changeset/yellow-countries-warn.md b/.changeset/yellow-countries-warn.md new file mode 100644 index 000000000..47f6157e3 --- /dev/null +++ b/.changeset/yellow-countries-warn.md @@ -0,0 +1,5 @@ +--- +'@powersync/node': patch +--- + +Update readme to refer to Node.js docs diff --git a/packages/node/README.md b/packages/node/README.md index d79ea8b5b..67c4e2dc1 100644 --- a/packages/node/README.md +++ b/packages/node/README.md @@ -9,7 +9,7 @@ _[PowerSync](https://www.powersync.com) is a sync engine for building local-firs This package (`packages/node`) is the PowerSync SDK for Node.js clients. It is an extension of `packages/common`. 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. -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). +See a summary of features [here](https://docs.powersync.com/client-sdk-references/node). ## Alpha Release @@ -28,9 +28,8 @@ or download sqlite3 and PowerSync binaries. # Getting Started -You can follow along our [web SDK reference](https://docs.powersync.com/client-sdk-references/js-web) -which contains everything you need to know to get started implementing PowerSync in your project. -Replace imports of `@powersync/web` with `@powersync/node` where necessary. +The [Node.js SDK reference](https://docs.powersync.com/client-sdk-references/node) +contains everything you need to know to get started implementing PowerSync in your project. # Examples