Skip to content

Update README.md #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 17, 2025
Merged

Update README.md #533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9d522a
Update README.md
benitav Mar 17, 2025
7c118b6
Add changeset
benitav Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/yellow-countries-warn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@powersync/node': patch
---

Update readme to refer to Node.js docs
7 changes: 3 additions & 4 deletions packages/node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down