diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8d48b18 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## 1.0.0-BETA.1 + +* Initial Beta release diff --git a/README.md b/README.md index 85a62ba..033c00b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,41 @@ +
+ +*[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: "