-
Notifications
You must be signed in to change notification settings - Fork 31
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.
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
Readme update #19
Readme update #19
Conversation
Codecov Report
@@ Coverage Diff @@
## main #19 +/- ##
=========================================
Coverage 82.59% 82.59%
Complexity 92 92
=========================================
Files 17 17
Lines 247 247
Branches 13 13
=========================================
Hits 204 204
Misses 33 33
Partials 10 10
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
This looks great! The Snyk badge doesn't seem to be working though. |
### Configure it | ||
To configure it, you'll need to add a provider to the global singleton `OpenFeatureAPI`. From there, you can generate a `Client` which is usable by your code. While you'll likely want a provider for your specific backend, we've provided a `NoOpProvider`, which simply returns the default passed in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could link to the provider spec, but this makes me think it would be nice to have a less technical section at the start of each spec page that we could link to that explains in non-normative (plain English) with diagrams some high level concepts.
cc @beeme1mr
<a href="https://github.com/open-feature/java-sdk/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=open-feature/java-sdk" /> | ||
</a> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love this.
Rendered: https://github.com/open-feature/java-sdk/tree/readme-update#readme
Fixes #15