Skip to content

Commit

Permalink
Add note to ReadMe on experimental non-JVM usage
Browse files Browse the repository at this point in the history
  • Loading branch information
russellbanks committed Sep 27, 2023
1 parent 0b8424e commit 1948f49
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ This library adds YAML support to [kotlinx.serialization](https://github.com/Kot

Currently, only Kotlin/JVM is fully supported.

Kotlin/JS support is considered highly experimental. It is not yet fully functional, and may be removed or modified at any time.
Kotlin/JS and Kotlin/Native support is currently experimental. It has not been tested to the same extent as Kotlin/JVM and may be modified at any time.

(Follow [this issue](https://github.com/charleskorn/kaml/issues/232) for a discussion of adding support for other targets.)
(Follow [this issue](https://github.com/charleskorn/kaml/issues/232) for a discussion and progress on the stability of Kotlin/JS and Kotlin/Native.)

YAML version 1.2 is supported.

Expand Down Expand Up @@ -88,8 +88,8 @@ Add the following to your Gradle build script:

```groovy
plugins {
id 'org.jetbrains.kotlin.jvm' version '1.4.20'
id 'org.jetbrains.kotlin.plugin.serialization' version '1.4.20'
id 'org.jetbrains.kotlin.multiplatform' version '1.9.10'
id 'org.jetbrains.kotlin.plugin.serialization' version '1.9.10'
}
dependencies {
Expand All @@ -101,8 +101,8 @@ dependencies {

```kotlin
plugins {
kotlin("jvm") version "1.4.20"
kotlin("plugin.serialization") version "1.4.20"
kotlin("multiplatform") version "1.9.10"
kotlin("plugin.serialization") version "1.9.10"
}

dependencies {
Expand Down
3 changes: 0 additions & 3 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,12 @@ kotlin {
}

val jvmMain by getting {

dependencies {
implementation("org.snakeyaml:snakeyaml-engine:2.6")
}
}

val jvmTest by getting {
dependsOn(commonTest)

dependencies {
implementation("io.kotest:kotest-runner-junit5:5.6.2")
}
Expand Down

0 comments on commit 1948f49

Please sign in to comment.