diff --git a/README.md b/README.md index 942150d..55cbdb1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ -# react-optimistic-toggle -React component to optimistically handle async toggles. +# React Optimistic Toggle +React component to build Optimistic UIs. + +If you see the 'FB or Twitter Like Button' or 'Add To Favorite' button in many websites you'll notice that when you click on the button it instantly shows that you have liked it. It then sends a request, if the request succeeds then the post stays liked otherwise it reverts back to unliked state. This is called Optimistic UI update. + +`react-optimistic-toggle` helps you build these kind of UI effortlessly. + +* [Docs](https://react-optimistic-toggle.netlify.com/) +* [npm](https://www.npmjs.com/package/react-optimistic-toggle)