docs: add read me sections

Author: wallace-sf

README.md

@@ -1,10 +1,21 @@
 
 # React MQTT Workflow Manager
 
-React MQTT Workflow Manager is a React component library designed to wrap all MQTT pub/sub logic behind the scenes. This manager comunicates with your broker to dispatch actions in your front-end application. The library also was designed to work with [Workflow API Layer](https://github.com/flow-build/workflow-api).
+React MQTT Workflow Manager is a React component library designed to wrap all [MQTT](https://mqtt.org/) sub logic behind the scenes. It deals only with events, no commands. The manager comunicates with your broker to dispatch actions in your front-end application. The library is focused to work with [Workflow API Layer](https://github.com/flow-build/workflow-api).
 
+## Table of contents
 
-## Installation
+ - [Installation](#installation)
+ - [Dependencies](#dependencies)
+ - [Usage](#usage)
+ - [Properties](#properties)
+ - [WorkflowManagerConfig](#workflowmanagerconfig)
+ - [Hooks](#hooks)
+ - [Running locally](#running-locally)
+ - [Authors](#authors)
+ - [License](#license)
+
+## [Installation](installation)
 
 ```bash
 npm install @flowbuild/react-mqtt-workflow-manager --save
@@ -14,19 +25,36 @@ or
 ```bash
 yarn add @flowbuild/react-mqtt-workflow-manager
 ```
-## Dependencies
+## [Dependencies](dependencies)
 
 The `WorkflowManager` component [peer depends](https://docs.npmjs.com/files/package.json#peerdependencies) on the [React](https://www.npmjs.com/package/react) and [React DOM](https://www.npmjs.com/package/react-dom) in version 18.
 
 ```bash
 npm i react@18 react-dom@18
 ```
-## Usage
+## [Usage](usage)
+
+
+1. Before the componente usage, set the store with `WorkflowManagerConfig.setStore`.
+
+```tsx
+// App.tsx
+
+import * as React from 'react';
+
+import { WorkflowManagerConfig } from '@flowbuild/react-mqtt-workflow-manager';
+
+import { store } from './store'; // Your redux store
+
 
+WorkflowManagerConfig.setStore(store);
+
+// ...
+```
 
-1. Wrap you application with ``WorkflowManager`` component. Don't forget to set your store with ``WorkflowManagerConfig.setStore`` before the componente usage. This is important, because the library needs redux functions to work correctly.
+2. Wrap your application with `WorkflowManager`.
 
-```jsx
+```tsx
 // App.tsx
 
 import * as React from 'react';
@@ -56,59 +84,123 @@ export const App: React.FC = () => {
 };
 ```
 
-## Properties
+3. Lastly, set `workflowManagerReducer` to your store reducers.
+
+```ts
+import { configureStore, createSlice } from '@reduxjs/toolkit';
+
+import { workflowManagerReducer, WorkflowManagerConfig } from '@flowbuild/react-mqtt-workflow-manager';
+
+const myAppSlice = createSlice({
+  name: '@myApp',
+  ...
+});
+
+export const store = configureStore({
+  reducer: { myApp: myAppSlice.reducer, workflowManagerReducer },
+});
+
+```
+
+## [Properties](properties)
 
 Property          | Type             | Required             | Description
 ---               | ---              | ---                  | ---
 `brokerUrl`       | *string*         | false                | URL to connect to broker. Use full URL like ws://
 `options`         | *IClientOptions* | false                | MQTT client options. See [MQTT.js](https://github.com/mqttjs/MQTT.js/blob/main/types/lib/client-options.d.ts).
 
+## [WorkflowManagerConfig](workflowmanagerconfig)
+
+The library also exposes methods and utilities for your commodity. They can be used out of the context of react components.
 
-## Running locally
+### setStore(store)
 
-Clone o projeto
+The library use your redux store to dispatch actions. This is used to dispatch internal actions control and for your applications.
+
+### getMqttClient()
+
+A utility method to be used out of context to react components. Be careful; the method must be able to return `null` if an error happens when setting connect. [See here](https://github.com/mqttjs/MQTT.js/blob/main/README.md#client).
+
+### subscribe(topic/topic array/topic object, [options])
+
+Works like exactly like [mqtt#subscribe](https://github.com/mqttjs/MQTT.js/blob/main/README.md#mqttclientsubscribetopictopic-arraytopic-object-options-callback), but the library implements validations and internal rules.
+
+### subscribe(topic/topic array/topic object, [options])
+
+Works like exactly like [mqtt#unsubscribe](https://github.com/mqttjs/MQTT.js/blob/main/README.md#mqttclientunsubscribetopictopic-array-options-callback), but the library implements validations and internal rules.
+
+## [Hooks](hooks)
+
+Some hooks are exported for commodity.
+
+### useMqtt()
+
+The hook returns a object contaning `client`, `status` and `error`.
+
+Property          | Type             | Default value    | Description
+---               | ---              | ---              | ---
+`client`          | *MqttClient*     | `null`           | See type [here](https://github.com/mqttjs/MQTT.js/blob/main/types/lib/client.d.ts)
+`status`          | *string*         | `offline`        | `connecting`, `connected`, `disconnected`, `reconnecting`, `offline` or `error`.
+`error`           | *Error*          | `null` |
+
+### useSubscribe()
+
+Returns `WorkflowManagerConfig.subscribe` for your commodity.
+
+### UseUnsubscribe()
+
+Returns `WorkflowManagerConfig.unsubscribe` for your commodity.
+
+## [Running locally](running-locally)
+
+Clone the project
 
 ```bash
 git clone https://github.com/flow-build/react-mqtt-workflow-manager.git
 ```
 
-Entre no diretório do projeto
+Go to the project directory
 
 ```bash
 cd react-mqtt-workflow-manager
 ```
 
-Instale as dependências
+Install dependencies
 
 ```bash
 npm install
 ```
 
-Inicie o servidor
+Start the development server
 
 ```bash
 npm run dev
 ```
 
+Go to the project example directory
+
 ```bash
 cd app
 ```
 
+Install de example dependencies
+
 ```bash
 npm install
 ```
 
+Start the example application
+
 ```bash
 npm run start
 ```
 
 
-## Authors
+## [Authors](authors)
 
 [@wallace-sf](https://www.github.com/wallace-sf)
 
 
-## License
+## [License](license)
 
 [MIT](https://choosealicense.com/licenses/mit/)
-