Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Update README.md #34

Merged
merged 4 commits into from
Jul 25, 2023
Merged

Update README.md #34

merged 4 commits into from
Jul 25, 2023

Conversation

nickybondarenko
Copy link
Contributor

Updating README.md using OpenFeature-provided template.

@nickybondarenko nickybondarenko marked this pull request as ready for review July 24, 2023 14:31
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@fabriziodemaria fabriziodemaria left a comment

Choose a reason for hiding this comment

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

I think we want a "context-aware evaluation" section as well here, similar to this

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
### Providers:

To develop a provider, you need to create a new project and include the OpenFeature SDK as a dependency.
This can be a new repository or included in [the existing contrib repository](https://github.com/open-feature/java-sdk-contrib) available under the OpenFeature organization.
Copy link
Member

Choose a reason for hiding this comment

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

This is linking to the java sdk contrib now. We'll need to wait for the kotlin contrib location to be ready before adding it to the documentation

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There's another place in the readme that links to Kotlin repo (which isn't populated yet) - let's keep in mind to update these upon release.

// get a bool flag value async
coroutineScope.launch {
WithContext(Dispatchers.IO) {
client.awaitProviderReady()
Copy link
Member

@fabriziodemaria fabriziodemaria Jul 25, 2023

Choose a reason for hiding this comment

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

Should we use the "raw" eventObserver here, and remove this helper function "awaitProviderReady"? It looks nice, but it's not in the OpenFeature Specs, and it adds more ways for users to wait on Provider's readiness, while it's probably nice to have a single way to achieve this using just events

@nickybondarenko nickybondarenko merged commit ccfc81a into main Jul 25, 2023
1 check passed
@nickybondarenko nickybondarenko deleted the readme branch July 25, 2023 14:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants