Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjenx committed Oct 30, 2024
1 parent fffda8c commit fabd036
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,37 @@ data class Merchant(
)
```

## Installation

### Gradle

Multiplatform projects (Android, JVM, iOS (coming soon))

```kotlin
commonMain {
dependencies {
implementation("com.mercury.sqkon:library:1.0.0-alpha01")
}
}
```

Or you can use the platform specific dependencies, e.g: Android only:

```kotlin
dependencies {
implementation("com.mercury.sqkon:library-android:1.0.0-alpha01")
}
```

## Project Requirements

The project is built upon [SQLDelight](https://github.com/sqldelight/sqldelight)
and [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization), these are transitive
dependencies, but you will not be able to use the library with applying the
kotlinx-serialization plugin. If you are not using kotlinx serialization, I suggest you read about it
here: https://github.com/Kotlin/kotlinx.serialization.

```kotlin

### Build platform artifacts

Expand Down

0 comments on commit fabd036

Please sign in to comment.