Merge pull request #14 from alevnyacow/feature/example-in-docs

added example in about section

Author: alevnyacow

README.md

@@ -9,7 +9,32 @@
 
 ## ✨ **About**
 
-Shared React variables provide you easy and comfortable mutable state management based on hooks. It's extremely simple - you generate a hook in one line and then you can use it anywhere to operate with your state! Also you can have any number of such state variables in your application.
+Shared React variables provide you easy and comfortable mutable state management based on hooks. It's extremely simple - you generate a hook in one line and then you can use it anywhere to operate with your state! Also you can have any number of such state variables in your application. 
+
+```tsx
+// creating timer state hook
+const useTimer = createUseSharedVariable({ ticks: 0 });
+
+const Timer = () => {
+    // using timer state
+    const timer = useTimer();
+    useEffect(() => {
+        setInterval(() => {
+            // state is mutable
+            timer.ticks++;
+        }, 1000);
+    }, []);
+
+    return <div>{timer.ticks}</div>
+};
+
+const AnotherTimerWithSameState = () => {
+    // using same timer state in another component
+    const timer = useTimer();
+
+    return <div>{timer.ticks}</div>
+};
+```
 
 ## 🔍 **Exported types**
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alevnyacow/shared-react-variables",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Easy and comfortable React state manager",
   "main": "transpiled/index.js",
   "scripts": {