-
-
Notifications
You must be signed in to change notification settings - Fork 266
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
Add an "About" section to the readme #170
Comments
PR is welcome. |
@kirill-konshin I'd definitely be willing to do a PR. I just don't feel like I understand the library well enough to explain it. To clarify my motivation for suggesting the additions to the readme, when I first came across the repo, I didn't really understand what it was. I was looking for something that would make Redux work with Next. I couldn't be sure |
Maybe I can suggest something in the next week... |
@cullylarson Something like that? |
It would be helpful to have some documentation of what the library is and why the library should be used, near the top of the readme (i.e. a sort of justification for the library's existence). Also, perhaps, an explanation of when not to use the library. There is some information like this scattered throughout the readme, but you have to read the whole thing to find it.
For example, I found these snippets really helpful, but they're all the way at the bottom of the doc:
The text was updated successfully, but these errors were encountered: