Add badges and usage.

This commit is contained in:
Justin Abrahms 2022-06-14 12:17:31 -07:00
parent 5142883c51
commit b0da7907b4
No known key found for this signature in database
GPG Key ID: 599E2E12011DC474
1 changed files with 44 additions and 3 deletions

View File

@ -1,5 +1,46 @@
# OpenFeature SDK for Java
This is an experimental Java SDK. The main motivation at the moment is to square away the API surface area to
ensure the work we're doing in typescript can be replicated in a less flexible language. This may become the official
Java SDK eventually, but now is not that time.
[![Project Status: WIP Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Known Vulnerabilities](https://snyk.io/test/github/open-feature/java-sdk/badge.svg)](https://snyk.io/test/github/open-feature/java-sdk)
[![on-merge](https://github.com/open-feature/java-sdk/actions/workflows/merge.yml/badge.svg)](https://github.com/open-feature/java-sdk/actions/workflows/merge.yml)
[![codecov](https://codecov.io/gh/open-feature/java-sdk/branch/main/graph/badge.svg?token=XMS9L7PBY1)](https://codecov.io/gh/open-feature/java-sdk)
This is the Java implementation of [Open Feature](https://openfeature.dev). It is intended to be used in server-side contexts and has not been evaluated for use in mobile devices.
## Usage
There are a variety flag types that we offer, but `Boolean` provides the simplest introduction. We can use this SDK to
```java
class MyClass {
// ...
public void myFunction() {
if (client.getBooleanValue("redesign_enabled", false)) {
return render_redesign();
}
return render_normal();
}
// ...
}
```
## Requirements
- Java 11
## Installation
TODO
## Contacting us
We hold regular meetings which you can see [here](https://github.com/open-feature/community/#meetings-and-events).
We are also present on the #openfeature channel in the [CNCF slack](https://slack.cncf.io/).
## Contributors
Thanks so much to our contributors.
<a href="https://github.com/open-feature/java-sdk/graphs/contributors">
<img src="https://contrib.rocks/image?repo=open-feature/java-sdk" />
</a>
Made with [contrib.rocks](https://contrib.rocks).