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.

Sign up for GitHub

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

docs: improve onboarding #150

Merged
merged 3 commits into from
Nov 21, 2023
Merged

docs: improve onboarding #150

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c9736c
docs: improve onboarding
gastonfournier Nov 20, 2023
d3f038a
Add two initialization options
gastonfournier Nov 21, 2023
8a01bf9
Fail fast on timeout
gastonfournier Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

This line makes me curious what are the other ways and why this is good for new joiners.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

unleash.WaitForReady()
}
```

Expand Down