diff --git a/README.md b/README.md index e546bba..920d0f1 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,38 @@ it depends on ktor-network support PTR. -AirPlay2(_airplay._tcp.local.) is tested \ No newline at end of file +Supported platforms: +1. windows64(mingwx64) +2. linuxX64 +3. linuxArm64 +4. macosArm64 +5. jvm(11 or later) + + +AirPlay2(_airplay._tcp.local.) is tested + +# How to use + +Add maven repository + +```kotlin +repositories { + mavenCentral() + maven("https://repo.maven.rtast.cn/releases") +} +``` + +Add dependency + +```kotlin +kotlin { + linuxX64() + // Add other platforms + + sourceSets { + commonMain.dependencies { + implementation("cn.rtast.nmdns:native-mdns:0.0.1") + } + } +} +``` \ No newline at end of file