Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ dependencies {
dokka(project(":core:"))
dokka(project(":connectors:supabase"))
dokka(project(":compose:"))
dokka(project(":integrations:room"))
dokka(project(":integrations:sqldelight"))
}

dokka {
Expand Down Expand Up @@ -97,9 +99,11 @@ develocity {
tasks.register("serveDokka") {
group = "dokka"
dependsOn("dokkaGenerate")
val rootProvider = layout.buildDirectory.dir("dokka/html")

doLast {
val root = rootProvider.get().asFile
val server = HttpServer.create(InetSocketAddress(0), 0)
val root = file("build/dokka/html")

val handler =
com.sun.net.httpserver.HttpHandler { exchange: HttpExchange ->
Expand Down
5 changes: 5 additions & 0 deletions integrations/room/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# PowerSync Room integration

> [!NOTE]
> Note that this package is currently in alpha.

This module provides the ability to use PowerSync with Room databases. This module aims for complete
Room support, meaning that:

1. Changes synced from PowerSync automatically update your Room `Flow`s.
2. Room and PowerSync cooperate on the write connection, avoiding "database is locked errors".
3. Changes from Room trigger a CRUD upload.

For more details on using this module, see its page on the [PowerSync documentation](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform/libraries/room).

## Setup

Add a dependency on `com.powersync:integration-room` with the same version you use for the main
Expand Down
5 changes: 5 additions & 0 deletions integrations/sqldelight/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
## PowerSync SQLDelight driver

> [!NOTE]
> Note that this package is currently in beta.

This library provides the `PowerSyncDriver` class, which implements an `SqlDriver` for `SQLDelight`
backed by PowerSync.

For more details on using this module, see its page on the [PowerSync documentation](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform/libraries/sqldelight).

## Setup

Add a dependency on `com.powersync:integration-sqldelight`, using the same version you use for the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import java.net.URI

plugins {
id("org.jetbrains.dokka")
}
Expand Down Expand Up @@ -28,7 +30,7 @@ dokka {
sourceLink {
localDirectory.set(project.rootDir)
remoteUrl.set(commit.map { commit ->
uri("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/")
URI.create("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/")
})
remoteLineSuffix.set("#L")
}
Expand Down
Loading