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.

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

Better doc #231

Open
raphael-jolimoi opened this issue May 4, 2021 · 1 comment
Open

Better doc #231

raphael-jolimoi opened this issue May 4, 2021 · 1 comment

Comments

@raphael-jolimoi
Copy link

The library is really hard to use. It is quite useful and powerful but the doc doesn't live up to basic usages of the library.

For example:

  • There isn't a list of available methods
  • There isn't a clear way explaining what the library expects from the API calls and what happens to the axios instance as a consequence
  • It lacks examples
@ajmas
Copy link

ajmas commented Dec 9, 2021

I have tried documenting the provider options in #241. As for other parts, if anyone can contribute suitable documentation, then I am sure the developers would appreciate it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants