Skip to content

Commit 8030cfd

Browse files
authored
Merge pull request #914 from powersync-ja/benitav-patch-1
Update README.md for PowerSync Tauri SDK
2 parents f720d62 + 19be4ce commit 8030cfd

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

.changeset/fresh-guests-dress.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@powersync/tauri-plugin': patch
3+
'tauri-plugin-powersync': patch
4+
---
5+
6+
Update feature status to alpha for Tauri SDK

packages/tauri/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22
<a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
33
</p>
44

5+
_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB, MySQL or SQL Server on the server-side._
6+
57
# PowerSync Tauri SDK
68

7-
_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB, MySQL or SQL Server on the server-side._
9+
> [!NOTE]
10+
> This SDK is currently in an [alpha state](https://docs.powersync.com/resources/feature-status), intended for external testing and public feedback. While this SDK exposes the same stable JavaScript APIs as our other JavaScript SDKs, it is based on our Rust SDK which is also in an alpha state. The Rust layer and the IPC protocol between the JS and Rust packages are subject to change.
11+
> Expect breaking changes and instability as development continues.
812
913
The PowerSync Tauri SDK (the `@powersync/tauri-plugin` package for JavaScript and the `tauri-plugin-powersync` crate) enable you to use PowerSync in Tauri (v2) apps.
1014

1115
For detailed usage instructions, see the full SDK reference [here](https://docs.powersync.com/client-sdks/reference/tauri).
1216

13-
## Stability
14-
15-
This SDK is based on our [Rust SDK](github.com/powersync-ja/powersync-native), which is currently in an experimental state.
16-
So while this package exposes the same stable JavaScript interfaces as our other JavaScript SDKs, the Tauri SDK is also in an experimental state at this point.
17-
1817
## Installation
1918

2019
To use this package, add `@powersync/tauri-plugin` using your favorite package management tool for JavaScript. Also use `cargo add tauri-plugin-powersync` in your `src-tauri` to add required native sources.

0 commit comments

Comments
 (0)