Skip to content

fix: update flagd provider docs, publishing #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 13, 2023
Merged

fix: update flagd provider docs, publishing #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jobs:
if: ${{ steps.release.outputs.releases_created }}
with:
fetch-depth: 0
submodules: recursive

- name: Install dependencies
if: ${{ steps.release.outputs.releases_created }}
Expand Down
10 changes: 5 additions & 5 deletions src/OpenFeature.Contrib.Providers.Flagd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Flagd Feature Flag .NET Provider
# flagd Feature Flag .NET Provider

The Flagd Flag provider allows you to connect to your Flagd instance.
The flagd Flag provider allows you to connect to your flagd instance.

# .Net SDK usage

Expand Down Expand Up @@ -38,7 +38,7 @@ paket add OpenFeature.Contrib.Providers.Flagd
#tool nuget:?package=OpenFeature.Contrib.Providers.Flagd
```

## Using the FlagdProvider with the OpenFeature SDK
## Using the flagd Provider with the OpenFeature SDK

This example assumes that the flagd server is running locally
For example, you can start flagd with the following example configuration:
Expand All @@ -47,7 +47,7 @@ For example, you can start flagd with the following example configuration:
flagd start --uri https://raw.githubusercontent.com/open-feature/flagd/main/config/samples/example_flags.json
```

When the flagd service is running, you can use the SDK with the FlagdProvider as in the following example console application:
When the flagd service is running, you can use the SDK with the flagd Provider as in the following example console application:

```csharp
using OpenFeature.Contrib.Providers.Flagd;
Expand All @@ -74,7 +74,7 @@ namespace OpenFeatureTestApp

### Configuring the FlagdProvider

The URI of the flagd server to which the `FlagdProvider` connects to can either be passed directly to the constructor, or be configured using the following environment variables:
The URI of the flagd server to which the `flagd Provider` connects to can either be passed directly to the constructor, or be configured using the following environment variables:

| Option name | Environment variable name | Type | Default | Values |
| --------------------- | ------------------------------- | ------- | --------- | ------------- |
Expand Down