|
35 | 35 |
|
36 | 36 | ### Requirements
|
37 | 37 |
|
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: |
39 | 39 |
|
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 | | |
41 | 49 |
|
42 |
| -### Install |
43 | 50 |
|
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). |
45 | 55 |
|
46 |
| -Installation via Maven Central is preferred, using the following dependency: |
| 56 | +### Installation |
47 | 57 |
|
| 58 | +Installation is preferred via Maven Central. |
| 59 | + |
| 60 | +#### In Android projects |
48 | 61 | <!-- x-release-please-start-version -->
|
| 62 | + |
49 | 63 | ```kotlin
|
50 | 64 | dependencies {
|
51 | 65 | api("dev.openfeature:kotlin-sdk:0.4.1")
|
52 | 66 | }
|
53 | 67 | ```
|
| 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 | + |
54 | 84 |
|
55 | 85 | ### Usage
|
56 | 86 |
|
|
0 commit comments