exported type ReactVariableHook, modified documentation

Author: alevnyacow

README.md

@@ -1,25 +1,32 @@
-# shared-react-variables
+# <p align="center">Shared React variables</p>
 
-Easy and comfortable React state manager.
+Easy and comfortable React mutable state manager 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 variables in your application.
 
-## API
+## <p align="center">1. Exported types</p>
 
-### **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).
+```ts
+type ReactVariableHook<T> = (rerenderOnChange?: boolean) => T;
+```
+
+## <p align="center">2. API</p>
+
+### <p align="center">createUseSharedVariable</p>
+#### **Description**
+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 in the hook).
 
-#### Signature
+#### **Signature**
 ```ts
-function createUseSharedVariable<T extends object>(initialState: T): (rerenderOnChange?: boolean) => T
+<T extends object>(initialState: T) => ReactVariableHook<T>;
 ```
 
-#### Usage example
+#### **Usage example**
 ```ts
 // feel free to use this state hook anywhere!
 const useTimer = createUseSharedVariable({ ticks: 0 });
 
 export { useTimer }
 ```
 
-## Example
+## <p align="center">3. Package usage example</p>
 
 https://codesandbox.io/s/react-shared-variables-example-f7feo7

package.json

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

sources/index.ts

@@ -4,7 +4,11 @@ import { deepProxy } from "@alevnyacow/deep-js-proxy";
 import { useRerenderer } from "./use-rerenderer";
 import { rerenderersList } from "./rerenderers-list";
 
-function createUseSharedVariable<T extends object>(initialState: T) {
+type ReactVariableHook<T> = (rerenderOnChange?: boolean) => T;
+
+function createUseSharedVariable<T extends object>(
+    initialState: T
+): ReactVariableHook<T> {
     const variableIdentifier = v4();
     const sharedVariable = deepProxy(
         [rerenderersList.fire],
@@ -35,4 +39,4 @@ function createUseSharedVariable<T extends object>(initialState: T) {
     return useSharedVariable;
 }
 
-export { createUseSharedVariable };
+export { createUseSharedVariable, ReactVariableHook };