Skip to content

Commit 6de50a5

Browse files
author
DominicGBauer
committed
docs: update readme and changelog
1 parent 3f8a0ca commit 6de50a5

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## 1.0.0-BETA.1
4+
5+
* Initial Beta release

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,41 @@
1+
<p align="center">
2+
<a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
3+
</p>
4+
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 or MySQL on the server-side.*
6+
17
# PowerSync Swift
28

39
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).
410

511
The SDK reference for the PowerSync Swift SDK is available [here](https://docs.powersync.com/client-sdk-references/swift).
612

7-
## Alpha Release
13+
## Beta Release
14+
15+
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.
16+
17+
## Structure: Packages
18+
19+
- [Sources](./Sources/)
20+
21+
- This is the Swift SDK implementation.
22+
23+
## Demo Apps / Example Projects
24+
25+
The easiest way to test the PowerSync Swift SDK is to run our demo application.
26+
27+
- [Demo/PowerSyncExample](./Demo/PowerSyncExample/README.md): A simple to-do list application demonstrating the use of the PowerSync Swift SDK using a Supabase connector.
28+
29+
## Installation
30+
31+
Add
32+
33+
```swift
34+
.package(url: "https://github.com/powersync-ja/powersync-swift", from: "<version>")
35+
```
36+
37+
to your `Package.swift` file to consume the latest release automatically or pin the dependency to a specific version:
838

9-
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.
39+
```swift
40+
.package(url: "https://github.com/powersync-ja/powersync-swift", exact: "<version>")
41+
```

0 commit comments

Comments
 (0)