Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jerrya committed Dec 4, 2024
1 parent 7714c4e commit be267d9
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,36 @@ Multiplatform-connectivity is a lightweight library for Compose/Kotlin Multiplat

It currently only supports iOS and Android.

## Platform Support

| Android | iOS | MacOS | Web | Linux | Windows |
| :-----: | :-: | :---: | :-: | :---: | :-----: |
|||||||


## Installation

Add the dependency to your libraries.toml file:

```toml
[libraries]
connectivity = { module = "io.github.jerrya:multiplaform-connectivity", version.ref = "multiplaform-connectivity" }
```
multiplatform-connectivity = { module = "io.github.jerrya:multiplaform-connectivity", version.ref = "multiplaform-connectivity" }

```toml
[versions]
multiplaform-connectivity = "1.0.0"
```

Then sync your project with Gradle.
Then sync your project with Gradle and add the dependency:

```groovy
kotlin {
sourceSets {
commonMain.dependencies {
implementation(libs.multiplatform.connectivity)
}
}
}
```

## Usage

Expand Down

0 comments on commit be267d9

Please sign in to comment.