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 more examples of how to use the configuration options #146

Open
BBlackwo opened this issue Apr 15, 2020 · 1 comment
Open

Add more examples of how to use the configuration options #146

BBlackwo opened this issue Apr 15, 2020 · 1 comment
Labels
docs Documentation update required help wanted

Comments

@BBlackwo
Copy link
Collaborator

BBlackwo commented Apr 15, 2020

As mentioned by @bdspen in #144 (comment). Opening a new issue specifically for the lack of config option examples.

If I might add, as a new user of the library I think it would be really nice to have more code examples of common configurations and usages of the library.

Something using mergeReducer, storage, and some of the other configurations like serialize and others in that list would be good too.

I did some experimenting with these properties to see what the library is capable of, but it would have been easier to look at some real world code samples.

Maybe there could be an examples folder with sample files?

I think a lot more info could be added to the README with some more examples, and if that's not enough potentially an examples folder too.

@BBlackwo BBlackwo added the docs Documentation update required label Apr 15, 2020
@BBlackwo
Copy link
Collaborator Author

Here's a good example of how to use the mergeReducer function if you don't want the state cloned. #128 (comment)

@BBlackwo BBlackwo assigned BBlackwo and unassigned BBlackwo Apr 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation update required help wanted
Projects
None yet
Development

No branches or pull requests

1 participant