-
Notifications
You must be signed in to change notification settings - Fork 59
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
Improve README and Documentation #1
Comments
Do the promises still work (or only work?) the way as described in the README? I am using the promises like so that seems to work also:
EDIT: looks like this is somewhat explained in the 0.9.x to 1.0.x upgrade section. |
Should do, if the promise ever resolves with an error(rejection). The second arg in the The Might need a more comprehensive example at the top of the README probably to explain this. |
Relevant: #53 |
I might look at making some nicer docs using GH pages so we can get a proper list of functions, and also add Or should we just be documenting examples with |
I'd say just using |
Agreed - I think we should just use async/await for examples. |
this documentation is very poor. despite my years of using api. i still struggle to get things done. probably drop use case examples |
The documentation and the README needs a bit of improvement.
The text was updated successfully, but these errors were encountered: