-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
DominicGBauer
committed
Dec 11, 2024
1 parent
3f8a0ca
commit 6de50a5
Showing
2 changed files
with
39 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Changelog | ||
|
||
## 1.0.0-BETA.1 | ||
|
||
* Initial Beta release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,41 @@ | ||
<p align="center"> | ||
<a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a> | ||
</p> | ||
|
||
*[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 or MySQL on the server-side.* | ||
|
||
# PowerSync Swift | ||
|
||
The PowerSync Swift SDK is an extension of the [PowerSync Kotlin Multiplatform SDK](https://github.com/powersync-ja/powersync-kotlin), and uses the API tool [SKIE](https://skie.touchlab.co/) and KMMBridge to generate and publish a native Swift SDK. More details about this configuration can be found in our blog [here](https://www.powersync.com/blog/using-kotlin-multiplatform-with-kmmbridge-and-skie-to-publish-a-native-swift-sdk). | ||
|
||
The SDK reference for the PowerSync Swift SDK is available [here](https://docs.powersync.com/client-sdk-references/swift). | ||
|
||
## Alpha Release | ||
## Beta Release | ||
|
||
This SDK is currently in a beta release it is suitable for production use, given you have tested your use case(s) extensively. If you find a bug or issue, please open a [GitHub issue](https://github.com/powersync-ja/powersync-swift/issues). Questions or feedback can be posted on our [community Discord](https://discord.gg/powersync) - we'd love to hear from you. | ||
|
||
## Structure: Packages | ||
|
||
- [Sources](./Sources/) | ||
|
||
- This is the Swift SDK implementation. | ||
|
||
## Demo Apps / Example Projects | ||
|
||
The easiest way to test the PowerSync Swift SDK is to run our demo application. | ||
|
||
- [Demo/PowerSyncExample](./Demo/PowerSyncExample/README.md): A simple to-do list application demonstrating the use of the PowerSync Swift SDK using a Supabase connector. | ||
|
||
## Installation | ||
|
||
Add | ||
|
||
```swift | ||
.package(url: "https://github.com/powersync-ja/powersync-swift", from: "<version>") | ||
``` | ||
|
||
to your `Package.swift` file to consume the latest release automatically or pin the dependency to a specific version: | ||
|
||
This SDK is currently in an alpha release and not suitable for production use, unless you have tested your use case(s) extensively. Breaking changes are still likely to occur. | ||
```swift | ||
.package(url: "https://github.com/powersync-ja/powersync-swift", exact: "<version>") | ||
``` |