From eb70985c8387ec6e3dc7a352352e8a3dd44a7966 Mon Sep 17 00:00:00 2001 From: benitav Date: Wed, 11 Dec 2024 13:41:38 +0200 Subject: [PATCH] Readme polish --- PowerSyncKotlin/README.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/PowerSyncKotlin/README.md b/PowerSyncKotlin/README.md index d2296724..5bd7e49f 100644 --- a/PowerSyncKotlin/README.md +++ b/PowerSyncKotlin/README.md @@ -1,5 +1,5 @@ # PowerSync Native Swift SDK -This is what is used to generate the Native Swift SDK using the Kotlin Multiplatform SDK with [SKIE](https://skie.touchlab.co/). Further 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 PowerSync Swift SDK is currently generated from this Kotlin Multiplatform SDK using the API tool [SKIE](https://skie.touchlab.co/). This folder contains the artifacts required for this. -We recommend the [Supabase Todo List Demo](https://github.com/powersync-ja/powersync-kotlin-swift-demo) app as a starting point for using the Swift SDK. See the README for details to run it. +See the [Swift SDK Reference](https://docs.powersync.com/client-sdk-references/swift) for more details. diff --git a/README.md b/README.md index 65f2be4a..3217de99 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ This is the PowerSync client SDK for Kotlin Mutliplatform. This SDK currently supports Android and iOS as targets. -See a summary of features [here](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform-alpha#sdk-features). +See a summary of features [here](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform#sdk-features). ## Beta release -This SDK is currently in a beta release. If you find a bug or issue, please open a [GitHub issue](https://github.com/powersync-ja/powersync-kotlin/issues). Questions or feedback can be posted on +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-kotlin/issues). Questions or feedback can be posted on our [community Discord](https://discord.gg/powersync) - we'd love to hear from you. ## Structure: Packages