Skip to content
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

Merged
merged 7 commits into from
Jun 15, 2022
Merged

Readme update #19

merged 7 commits into from
Jun 15, 2022

Conversation

justinabrahms
Copy link
Member

@justinabrahms justinabrahms commented Jun 14, 2022

@codecov-commenter
Copy link

Codecov Report

Merging #19 (a02f806) into main (5142883) will not change coverage.
The diff coverage is n/a.

@@            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           
Flag Coverage Δ
unittests 82.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5142883...a02f806. Read the comment docs.

@beeme1mr
Copy link
Member

This looks great! The Snyk badge doesn't seem to be working though.

@toddbaert toddbaert self-requested a review June 15, 2022 13:32
Comment on lines +72 to +73
### 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.
Copy link
Member

@toddbaert toddbaert Jun 15, 2022

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

Comment on lines +93 to +95
<a href="https://github.com/open-feature/java-sdk/graphs/contributors">
<img src="https://contrib.rocks/image?repo=open-feature/java-sdk" />
</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Actually fill out the README
4 participants