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

Add an "About" section to the readme #170

Closed
cullylarson opened this issue Jan 4, 2020 · 4 comments
Closed

Add an "About" section to the readme #170

cullylarson opened this issue Jan 4, 2020 · 4 comments

Comments

@cullylarson
Copy link
Contributor

cullylarson commented Jan 4, 2020

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 main purpose of this library is to make sure actions are consistently dispatched on all pages on client and on server from getInitialProps function...

If you need a static website you don't need this lib at all because you can always dispatch at client side on componentDidMount just like you normally would with bare React Redux, and let server only serve initial/static markup.

@kirill-konshin
Copy link
Owner

PR is welcome.

@cullylarson
Copy link
Contributor Author

cullylarson commented Jan 23, 2020

@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 next-redux-wrapper did that because there wasn't an explanation of what next-redux-wrapper is.

@bjoluc
Copy link
Contributor

bjoluc commented Jan 25, 2020

Maybe I can suggest something in the next week...

This was referenced Jan 31, 2020
@bjoluc
Copy link
Contributor

bjoluc commented Feb 4, 2020

@cullylarson Something like that?

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

3 participants