docs: Use SetProviderAndWait in README

[RedbackThomson]

This PR

There is a discrepancy between the default provider registration function in the docs on openfeature.dev and in the README of this repository. Since SetProvider is async, it makes more sense to default to using SetProviderAndWait in all documentation uniformly.

• updates the README to use SetProviderAndWait as the default registration function

Related Issues

Fixes N/A

Notes

Follow-up Tasks

How to test

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.13%. Comparing base (69d31fe) to head (5075e80).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #332   +/-   ##
=======================================
  Coverage   88.13%   88.13%           
=======================================
  Files          14       14           
  Lines        1408     1408           
=======================================
  Hits         1241     1241           
  Misses        143      143           
  Partials       24       24           

Flag	Coverage Δ
e2e	88.13% <ø> (ø)
unit	88.13% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[beeme1mr]

Both ways are valid but I agree that SetProviderAndWait is likely better in most example. Thanks for the PR.

[RedbackThomson]

Both ways are valid but I agree that SetProviderAndWait is likely better in most example. Thanks for the PR.

My team just spent a day trying to find the flake in our unit tests, which I figured out was coming from not using the wait version. I figure people don't realise the SetProvider is async and so can cause hidden problems for people new to OpenFeature

[beeme1mr]

My team just spent a day trying to find the flake in our unit tests, which I figured out was coming from not using the wait version.

Ah, sorry about that! FYI @toddbaert @lukas-reining @thomaspoignant

[beeme1mr]

@RedbackThomson could you please update the basic example at the top as well?

[toddbaert]

My team just spent a day trying to find the flake in our unit tests, which I figured out was coming from not using the wait version.

Ah, sorry about that! FYI @toddbaert @lukas-reining @thomaspoignant

Ya we should try to emphasize this in general as the "default" way. There's lots of cases where setting the provider asynchronously is valid (event-based frameworks such as React come to mind) but for demos and basic use cases the blocking version is much better.

[beeme1mr]

Sorry @RedbackThomson, I merged too soon. Feel free to open a separate PR.

[RedbackThomson]

#333