Skip to content

Commit b0da790

Browse files
committed
Add badges and usage.
1 parent 5142883 commit b0da790

File tree

1 file changed

+44
-3
lines changed

1 file changed

+44
-3
lines changed

README.md

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,46 @@
11
# OpenFeature SDK for Java
22

3-
This is an experimental Java SDK. The main motivation at the moment is to square away the API surface area to
4-
ensure the work we're doing in typescript can be replicated in a less flexible language. This may become the official
5-
Java SDK eventually, but now is not that time.
3+
[![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)
4+
[![Known Vulnerabilities](https://snyk.io/test/github/open-feature/java-sdk/badge.svg)](https://snyk.io/test/github/open-feature/java-sdk)
5+
[![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)
6+
[![codecov](https://codecov.io/gh/open-feature/java-sdk/branch/main/graph/badge.svg?token=XMS9L7PBY1)](https://codecov.io/gh/open-feature/java-sdk)
7+
8+
9+
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.
10+
11+
## Usage
12+
13+
There are a variety flag types that we offer, but `Boolean` provides the simplest introduction. We can use this SDK to
14+
15+
```java
16+
class MyClass {
17+
// ...
18+
public void myFunction() {
19+
if (client.getBooleanValue("redesign_enabled", false)) {
20+
return render_redesign();
21+
}
22+
return render_normal();
23+
}
24+
// ...
25+
}
26+
```
27+
28+
## Requirements
29+
- Java 11
30+
31+
## Installation
32+
TODO
33+
## Contacting us
34+
We hold regular meetings which you can see [here](https://github.com/open-feature/community/#meetings-and-events).
35+
36+
We are also present on the #openfeature channel in the [CNCF slack](https://slack.cncf.io/).
37+
38+
## Contributors
39+
40+
Thanks so much to our contributors.
41+
42+
<a href="https://github.com/open-feature/java-sdk/graphs/contributors">
43+
<img src="https://contrib.rocks/image?repo=open-feature/java-sdk" />
44+
</a>
45+
46+
Made with [contrib.rocks](https://contrib.rocks).

0 commit comments

Comments
 (0)