software-mansion / react-native-reanimated

React Native's Animated library reimplemented
https://docs.swmansion.com/react-native-reanimated/
MIT License
9.09k stars 1.32k forks source link

docs: fix `useEvent` typos, tweak wording of main `README` opening summary #6690

Open sorenfrederiksen opened 1 week ago

sorenfrederiksen commented 1 week ago

Summary

This pull request makes 2 changes to the library's documentation:

  1. In useEvent (versions 2 and 3), some typos, grammar details and instances of missing articles were corrected.
  2. In the library's main README, it tweaks the wording of the document's opening summary to make it more clear and more fluent in its expression.

I think 1 will be uncontroversial, but you might want to revert 2 if I've misunderstood what the author was trying to say.

(Just noticed these things while reading the documentation this evening. Please take, edit and use these proposed changes as you see fit 🙏)