Skip to content

Commit

Permalink
chore: add minimum flagd provider doc
Browse files Browse the repository at this point in the history
Signed-off-by: Todd Baert <toddbaert@gmail.com>
  • Loading branch information
toddbaert committed Nov 15, 2022
1 parent 0afb4d7 commit c6b57b5
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions providers/flagd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# flagd-web Provider for OpenFeature

![Experimental](https://img.shields.io/badge/experimental-breaking%20changes%20allowed-yellow)

A feature flag daemon with a Unix philosophy.

## Installation

```xml
<dependency>
<groupId>dev.openfeature.contrib.providers</groupId>
<artifactId>flagd</artifactId>
<version>0.5.0</version>
</dependency>
```

## Usage

The `FlagdProvider` communicates with flagd via the gRPC protocol. Instantiate a new FlagdProvider instance, and configure the OpenFeature SDK to use it:

```java
FlagdProvider provider = new FlagdProvider("http", "localhost", 8013);
OpenFeatureAPI.getInstance().setProvider(provider);
```

0 comments on commit c6b57b5

Please sign in to comment.