Skip to content

Commit

Permalink
docs: Install instructions in README (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
fabriziodemaria authored Oct 9, 2023
1 parent 470494e commit 77ecd7d
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,25 @@ To learn more about the basic concepts (flags, targeting key, evaluation context
the [OpenFeature reference documentation](https://openfeature.dev/docs/reference/intro) can be
useful.

# Using the provider
## Install

### Maven

<!-- x-release-please-start-version -->
```xml
<dependency>
<groupId>com.spotify.confidence</groupId>
<artifactId>openfeature-provider</artifactId>
<version>0.0.3</version>
</dependency>
```
<!---x-release-please-end-->

## Usage

The provider is instantiated using a client token that is configured in the Confidence UI or via the
management API. After that all interaction with the feature flags happens using the OpenFeature client APIs.

## Example

```java
package com.spotify.confidence.openfeature;

Expand Down

0 comments on commit 77ecd7d

Please sign in to comment.