Update READMEs

Author: stevensJourney

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.6.1 (unreleased)
 
 * Update Kotlin SDK to 1.7.0.
+* Added Alpha `PowerSyncGRDB` product which supports sharing GRDB `DatabasePool`s with PowerSync and application logic.
 
 ## 1.6.0
 

Demo/GRDB Demo/GRDB Demo/GRDB_DemoApp.swift

@@ -44,11 +44,9 @@ func openDatabase()
         fatalError("Could not open database")
     }
 
-    let powerSync = OpenedPowerSyncDatabase(
+    let powerSync = openPowerSyncWithGRDB(
+        pool: grdb,
         schema: schema,
-        pool: GRDBConnectionPool(
-            pool: grdb
-        ),
         identifier: "test"
     )
 

Demo/GRDB Demo/GRDB Demo/README.md

@@ -0,0 +1,50 @@
+# PowerSync Swift GRDB Demo App
+
+A Todo List app demonstrating the use of the PowerSync Swift SDK with GRDB and Supabase.
+
+## Set up your Supabase and PowerSync projects
+
+To run this demo, you need Supabase and PowerSync projects. Detailed instructions for integrating PowerSync with Supabase can be found in [the integration guide](https://docs.powersync.com/integration-guides/supabase).
+
+Follow this guide to:
+
+1. Create and configure a Supabase project.
+2. Create a new PowerSync instance, connecting to the database of the Supabase project. See instructions [here](https://docs.powersync.com/integration-guides/supabase-+-powersync#connect-powersync-to-your-supabase).
+3. Deploy sync rules.
+
+## Configure The App
+
+1. Open this directory in XCode.
+
+2. Copy the `_Secrets.swift` file to a new `Secrets.swift` file and insert the credentials of your Supabase and PowerSync projects (more info can be found [here](https://docs.powersync.com/integration-guides/supabase-+-powersync#test-everything-using-our-demo-app)).
+
+```bash
+cp _Secrets.swift Secrets.swift
+```
+
+### GRDB Implementation Details
+
+This demo uses GRDB.swift for local data storage and querying. The key differences from the standard PowerSync demo are:
+
+1. Queries and mutations are handled using GRDB's data access patterns
+2. Observable database queries are implemented using GRDB's ValueObservation
+
+### Troubleshooting
+
+If you run into build issues, try:
+
+1. Clear Swift caches
+
+```bash
+rm -rf ~/Library/Caches/org.swift.swiftpm
+rm -rf ~/Library/org.swift.swiftpm
+```
+
+2. In Xcode:
+
+- Reset Packages: File -> Packages -> Reset Package Caches
+- Clean Build: Product -> Clean Build Folder.
+
+## Run project
+
+Build the project, launch the app and sign in or register a new user. The app demonstrates real-time synchronization of todo lists between multiple devices and the cloud, powered by PowerSync's offline-first architecture and GRDB's robust local database capabilities.

Package.swift

@@ -7,7 +7,7 @@ let packageName = "PowerSync"
 
 // Set this to the absolute path of your Kotlin SDK checkout if you want to use a local Kotlin
 // build. Also see docs/LocalBuild.md for details
-let localKotlinSdkOverride: String? = "/Users/stevenontong/Documents/platform_code/powersync/powersync-kotlin"
+let localKotlinSdkOverride: String? = "/Users/stevenontong/Documents/platform_code/powersync/powersync-kotlin/internal"
 
 // Set this to the absolute path of your powersync-sqlite-core checkout if you want to use a
 // local build of the core extension.

README.md

@@ -22,6 +22,8 @@ The easiest way to test the PowerSync Swift SDK is to run our demo application.
 
 - [Demo/PowerSyncExample](./Demo/README.md): A simple to-do list application demonstrating the use of the PowerSync Swift SDK using a Supabase connector.
 
+- [Demo/GRDB Demo](./Demo/README.md): A simple to-do list application demonstrating the use of the PowerSync Swift SDK using a Supabase connector and GRDB connections.
+
 ## Installation
 
 Add
@@ -103,10 +105,17 @@ let dbPool = try DatabasePool(
 let powerSync = try openPowerSyncWithGRDB(
     pool: dbPool,
     schema: mySchema,
-    identifier: "app-db"
+    identifier: "app-db.sqlite"
 )
 ```
 
+Feel free to use the `DatabasePool` for view logic and the `PowerSyncDatabase` for PowerSync operations.
+
+#### Limitations
+
+- Updating the PowerSync schema, with `updateSchema`, is not currently fully supported with GRDB connections.
+- This integration requires currently statically linking PowerSync and GRDB.
+
 ## Underlying Kotlin Dependency
 
 The PowerSync Swift SDK makes use of the [PowerSync Kotlin Multiplatform SDK](https://github.com/powersync-ja/powersync-kotlin) and the API tool [SKIE](https://skie.touchlab.co/) under the hood to implement the Swift package.