README.md suggestions - Githubissues

merisbahti / klyva

A state management library that follows the React component model

MIT License

55 stars 4 forks source link

README.md suggestions #31

Open godspeedelbow opened 3 years ago

godspeedelbow commented 3 years ago

Some things that came up when trying out Klyva:

make optics part of the Klyva tagline. it's the thing that really sets this lib apart from all others. good to communicate that from the start.
considering optics is such a big thing in this library, I think it would be great to give some practical examples.
start examples with import statement, e.g.

import {atom} from 'klyva'

const countAtom = atom(5)

I know it's written in the docs but I still didn't parse it completely when I read it: it's if you want your component to update when an atom changes, you gotta use the useAtom or useSelector hook in that component.

merisbahti commented 3 years ago

Hey Eelke, thanks for the issue :)

I agree 100%, currently thinking about how this will be done.