@powersync/node 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +7 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -9,7 +9,11 @@ _[PowerSync](https://www.powersync.com) is a sync engine for building local-firs
9
9
  This package (`packages/node`) is the PowerSync SDK for Node.js clients. It is an extension of `packages/common`.
10
10
  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.
11
11
 
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).
13
+
14
+ ## Alpha Release
15
+
16
+ The `@powersync/node` package is currently in an Alpha release.
13
17
 
14
18
  # Installation
15
19
 
@@ -24,9 +28,8 @@ or download sqlite3 and PowerSync binaries.
24
28
 
25
29
  # Getting Started
26
30
 
27
- You can follow along our [web SDK reference](https://docs.powersync.com/client-sdk-references/js-web)
28
- which contains everything you need to know to get started implementing PowerSync in your project.
29
- 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.
30
33
 
31
34
  # Examples
32
35
 
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@powersync/node",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
7
7
  },
8
- "description": "PowerSync - sync Postgres with SQLite in your Node.js app for offline-first and real-time data",
8
+ "description": "PowerSync Node.js SDK. Sync Postgres, MongoDB or MySQL with SQLite in your Node.js app",
9
9
  "main": "./lib/index.js",
10
10
  "module": "./lib/index.js",
11
11
  "types": "./lib/index.d.ts",