Skip to content

Commit 1a76c44

Browse files
committed
Document supported platforms
Signed-off-by: Bence Hornák <bence.hornak@gmail.com>
1 parent 46c4f47 commit 1a76c44

File tree

1 file changed

+35
-5
lines changed

1 file changed

+35
-5
lines changed

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,52 @@
3535

3636
### Requirements
3737

38-
- The Android minSdk version supported is: `21`.
38+
The following [Kotlin Multiplatform Targets](https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-dsl-reference.html#targets) are supported:
3939

40-
Note that this library is intended to be used in a mobile context, and has not been evaluated for use in other types of applications (e.g. server applications).
40+
| Supported | Platform | Supported versions |
41+
|-----------|----------------------|--------------------------------------------------------------------------------|
42+
|| Android | SDK 21+ |
43+
|| JVM | JDK 11+ |
44+
|| Native | Linux x64 |
45+
|| Native | [Other native targets](https://kotlinlang.org/docs/native-target-support.html) |
46+
|| Javascript (Node.js) | |
47+
|| Javascript (Browser) | |
48+
|| Wasm | |
4149

42-
### Install
4350

44-
#### Maven Central
51+
Note that this library adheres to the
52+
[Static Context Paradigm](https://openfeature.dev/docs/reference/concepts/sdk-paradigms), so it is
53+
intended to be used on the **client side** (i.e. mobile apps, web apps and desktop apps), and has
54+
not been evaluated for use in other types of applications (e.g. server applications).
4555

46-
Installation via Maven Central is preferred, using the following dependency:
56+
### Installation
4757

58+
Installation is preferred via Maven Central.
59+
60+
#### In Android projects
4861
<!-- x-release-please-start-version -->
62+
4963
```kotlin
5064
dependencies {
5165
api("dev.openfeature:kotlin-sdk:0.4.1")
5266
}
5367
```
68+
<!-- x-release-please-end -->
69+
70+
#### In multiplatform projects
71+
72+
<!-- x-release-please-start-version -->
73+
```kotlin
74+
kotlin {
75+
sourceSets {
76+
commonMain.dependencies {
77+
api("dev.openfeature:kotlin-sdk:0.4.1")
78+
}
79+
}
80+
}
81+
```
82+
<!-- x-release-please-end -->
83+
5484

5585
### Usage
5686

0 commit comments

Comments
 (0)