Skip to content

Commit 6b83087

Browse files
update readme
1 parent 0a9bae6 commit 6b83087

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

core/README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
# PowerSync core module
22

3-
The PowerSync core module provides the core functionality for the PowerSync Kotlin Multiplatform SDK.
3+
The PowerSync core module provides the core functionality for the PowerSync Kotlin Multiplatform
4+
SDK.
45

56
## Structure
67

7-
This is a Kotlin Multiplatform project targeting Android, iOS platforms, with the following structure:
8+
This is a Kotlin Multiplatform project targeting Android, iOS platforms, with the following
9+
structure:
810

9-
- `commonMain` - Shared code for all targets, which includes the `PowerSyncBackendConnector` interface and `PowerSyncBuilder` for building a `PowerSync` instance. It also defines
11+
- `commonMain` - Shared code for all targets, which includes the `PowerSyncBackendConnector`
12+
interface and `PowerSyncBuilder` for building a `PowerSync` instance. It also defines
1013
the `DatabaseDriverFactory` class to be implemented in each platform.
11-
- `commonJDBC` - A Java SQLite driver using the [Xerial JDBC Driver](https://github.com/xerial/sqlite-jdbc). This is used by both the Android and JVM drivers.
12-
- `androidMain` - Android specific code, which includes an implementation of `DatabaseDriverFactory`.
14+
- `commonJava` - Common Java code including a Java SQLite driver using
15+
the [Xerial JDBC Driver](https://github.com/xerial/sqlite-jdbc). This is used by both the Android
16+
and JVM drivers.
17+
- `androidMain` - Android specific code, which includes an implementation of
18+
`DatabaseDriverFactory`.
1319
- `jvmMain` - JVM specific code which includes an implementation of `DatabaseDriverFactory`.
14-
- `iosMain` - iOS specific code, which includes am implementation of `DatabaseDriverFactory` class that creates an instance of `app.cash.sqldelight.driver.native.NativeSqliteDriver` and also sets up native SQLite bindings for iOS.
20+
- `iosMain` - iOS specific code, which includes am implementation of `DatabaseDriverFactory` class
21+
that creates an instance of `app.cash.sqldelight.driver.native.NativeSqliteDriver` and also sets
22+
up native SQLite bindings for iOS.
1523

1624
## Note on SQLDelight
1725

18-
The PowerSync core module, internally makes use of [SQLDelight](https://cashapp.github.io/sqldelight) for it database API and typesafe database query generation.
26+
The PowerSync core module, internally makes use
27+
of [SQLDelight](https://cashapp.github.io/sqldelight) for it database API and typesafe database
28+
query generation.
1929

20-
The PowerSync core module does not currently support integrating with SQLDelight from client applications.
30+
The PowerSync core module does not currently support integrating with SQLDelight from client
31+
applications.

core/src/androidMain/kotlin/com/powersync/DatabaseDriverFactory.android.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import com.powersync.db.migrateDriver
88
import kotlinx.coroutines.CoroutineScope
99
import org.sqlite.SQLiteCommitListener
1010

11-
@Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING", "SqlNoDataSourceInspection")
11+
@Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")
1212
public actual class DatabaseDriverFactory(
1313
private val context: Context,
1414
) {

0 commit comments

Comments
 (0)