Skip to content

Commit 11b5fe7

Browse files
authored
chore: add minimum flagd provider doc (#126)
Signed-off-by: Todd Baert <[email protected]> Signed-off-by: Todd Baert <[email protected]>
1 parent 0afb4d7 commit 11b5fe7

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

providers/flagd/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# flagd Provider for OpenFeature
2+
3+
![Experimental](https://img.shields.io/badge/experimental-breaking%20changes%20allowed-yellow)
4+
5+
A feature flag daemon with a Unix philosophy.
6+
7+
## Installation
8+
<!-- x-release-please-start-version -->
9+
```xml
10+
<dependency>
11+
<groupId>dev.openfeature.contrib.providers</groupId>
12+
<artifactId>flagd</artifactId>
13+
<version>0.5.0</version>
14+
</dependency>
15+
```
16+
<!-- x-release-please-end-version -->
17+
18+
## Usage
19+
20+
The `FlagdProvider` communicates with flagd via the gRPC protocol. Instantiate a new FlagdProvider instance, and configure the OpenFeature SDK to use it:
21+
22+
```java
23+
FlagdProvider provider = new FlagdProvider("http", "localhost", 8013);
24+
OpenFeatureAPI.getInstance().setProvider(provider);
25+
```

release-please-config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
"bump-patch-for-minor-pre-major": true,
99
"versioning": "default",
1010
"extra-files": [
11-
"pom.xml"
11+
"pom.xml",
12+
"README.md"
1213
]
1314
},
1415
"providers/go-feature-flag": {

0 commit comments

Comments
 (0)