docs: improve onboarding #150
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When getting started with go sdk it's easy to miss waiting for initialization. This change will make it easy for newcomers to use the SDK and more advanced users should be able to wait for the readiness in different ways if they don't want to block the main thread
kwasniew
reviewed
Nov 21, 2023
kwasniew
reviewed
Nov 21, 2023
README.md
Outdated
| @@ -46,6 +46,9 @@ func init() { | |||
| unleash.WithUrl("http://unleash.herokuapp.com/api/"), | |||
| unleash.WithCustomHeaders(http.Header{"Authorization": {"<API token>"}}), | |||
| ) | |||
|
|
|||
| // The line below will block until the default client is ready or returns immediately. You can wait for readiness in a different way but this is good for new joiners | |||
There was a problem hiding this comment.
This line makes me curious what are the other ways and why this is good for new joiners.
There was a problem hiding this comment.
Most show different ways of initializing: sync vs async. Example: https://github.com/Unleash/unleash-client-java#example-configurations
Maybe we can use a similar format. I'm just waiting for confirmation that this was actually the problem
kwasniew
approved these changes
Nov 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When getting started with go sdk it's easy to miss waiting for initialization. This change will make it easy for newcomers to use the SDK and more advanced users should be able to wait for the readiness in different ways if they don't want to block the main thread