Skip to content

Commit

Permalink
chore: Remove mentions of jitpack. Adjusts maven central instructions (
Browse files Browse the repository at this point in the history
…#78)

Signed-off-by: Nicklas Lundin <[email protected]>
  • Loading branch information
nicklasl authored Dec 18, 2023
1 parent f7c7ab0 commit 1246d5d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 25 deletions.
2 changes: 0 additions & 2 deletions OpenFeature/jitpack.yaml

This file was deleted.

27 changes: 4 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
<!-- x-release-please-end -->
<br/>
<img alt="Status" src="https://img.shields.io/badge/lifecycle-alpha-a0c3d2.svg" />
<a href="https://jitpack.io/#open-feature/kotlin-sdk">
<img alt="JitPack" src="https://jitpack.io/v/open-feature/kotlin-sdk.svg" />
<a href="https://mvnrepository.com/artifact/dev.openfeature/kotlin-sdk">
<img alt="MavenCentral" src="https://img.shields.io/maven-central/v/dev.openfeature/kotlin-sdk" />
</a>
</p>
<!-- x-hide-in-docs-start -->
Expand All @@ -43,34 +43,15 @@ Note that this library is intended to be used in a mobile context, and has not b

#### Maven Central

Installation via Maven Central is currently [WIP](https://github.com/open-feature/kotlin-sdk/issues/37)
Installation via Maven Central is preferred, using the following dependency:

<!-- x-release-please-start-version -->
You can add the OpenFeature SDK dependency:
```kotlin
dependencies {
api("com.github.open-feature:kotlin-sdk:0.1.0")
api("dev.openfeature:kotlin-sdk:0.1.0")
}
```

#### Jitpack

The Android project must include `maven("https://jitpack.io")` in `settings.gradle`.

You can now add the OpenFeature SDK dependency:
```kotlin
dependencies {
api("com.github.open-feature:kotlin-sdk:0.1.0")
}
```
<!-- x-release-please-end -->
Please note that the `version` can be any `Commit SHA` or a version based on a branch as follows:
```sh
api("com.github.open-feature:kotlin-sdk:[ANY_BRANCH]-SNAPSHOT")
```

This will get a build from the head of the mentioned branch.

### Usage

```kotlin
Expand Down

0 comments on commit 1246d5d

Please sign in to comment.