Skip to content

Commit bf6c59f

Browse files
committed
docs: improvements
1 parent 6de50a5 commit bf6c59f

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
# PowerSync Swift
88

9-
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).
10-
119
The SDK reference for the PowerSync Swift SDK is available [here](https://docs.powersync.com/client-sdk-references/swift).
1210

1311
## Beta Release
@@ -31,11 +29,21 @@ The easiest way to test the PowerSync Swift SDK is to run our demo application.
3129
Add
3230

3331
```swift
34-
.package(url: "https://github.com/powersync-ja/powersync-swift", from: "<version>")
32+
.package(url: "https://github.com/powersync-ja/powersync-swift", exact: "<version>")
3533
```
3634

37-
to your `Package.swift` file to consume the latest release automatically or pin the dependency to a specific version:
3835

39-
```swift
40-
.package(url: "https://github.com/powersync-ja/powersync-swift", exact: "<version>")
41-
```
36+
to your `Package.swift` file and pin the dependency to a specific version. This is required because the package is in beta.
37+
38+
## Underlying Kotlin Dependency
39+
40+
The PowerSync Swift SDK currently makes use of the [PowerSync Kotlin Multiplatform SDK](https://github.com/powersync-ja/powersync-kotlin) with the API tool [SKIE](https://skie.touchlab.co/) and KMMBridge under the hood to help generate and publish the native Swift SDK. We will move to an entirely Swift native API in v1 and do not expect there to be any breaking changes.
41+
42+
43+
## Migration from Alpha to Beta
44+
45+
* The `PowerSyncDatabase` no longer needs a driver argument and it must be removed.
46+
* The interface for `PowerSyncDatabase` now uses `PowerSyncDatabaseProtocol` which may require some changes to databases uses.
47+
* If you were using `__uploadData` and `__fetchCredentials` in your `PowerSyncBackendConnector` you must remove the `__` and update the methods to `uploadData` and `fetchCredentials`.
48+
* `@MainThread` usage is no longer required and should be removed.
49+
* Implementing `SuspendTaskWrapper` for database transactions is no longer required and should be removed.

0 commit comments

Comments
 (0)