From be267d91440cf5de419acb36c8fb494238f2da4e Mon Sep 17 00:00:00 2001 From: Jerry Date: Tue, 3 Dec 2024 21:41:20 -0600 Subject: [PATCH] updated readme --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f97670f..b3518f5 100644 --- a/README.md +++ b/README.md @@ -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