Merge pull request #8 from alevnyacow/feature/documentation

added basic README info

Author: alevnyacow

README.md

@@ -1,2 +1,25 @@
 # shared-react-variables
-Shared React variables
+
+Easy and comfortable React state manager.
+
+## API
+
+### **createUseSharedVariable**
+Takes initial state as a parameter. Returns a hook can be imported and used anywhere in your application. When you use this hook, it returns you mutable global state. Whenever this state is changed component will be rerendered (this behaviour can be changed via *rerenderOnChange* flag).
+
+#### Signature
+```ts
+function createUseSharedVariable<T extends object>(initialState: T): (rerenderOnChange?: boolean) => T
+```
+
+#### Usage example
+```ts
+// feel free to use this state hook anywhere!
+const useTimer = createUseSharedVariable({ ticks: 0 });
+
+export { useTimer }
+```
+
+## Example
+
+https://codesandbox.io/s/react-shared-variables-example-f7feo7

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alevnyacow/shared-react-variables",
-  "version": "0.0.3",
+  "version": "1.0.0",
   "description": "Easy and comfortable React state manager",
   "main": "transpiled/index.js",
   "scripts": {
@@ -48,5 +48,5 @@
   "bugs": {
     "url": "https://github.com/alevnyacow/shared-react-variables/issues"
   },
-  "homepage": "https://github.com/alevnyacow/shared-react-variables#readme"
+  "homepage": "https://codesandbox.io/s/react-shared-variables-example-f7feo7"
 }