Update README.md

Author: Luke Brandon Farrell

docs/README.md

@@ -15,34 +15,18 @@ import { createPersistMachine } from "redux-persist-machine";
 
 ### Setup
 
-There are a couple of things you need to get started. Firstly add the return of `createPersistMiddleware` to your redux middleware.
-
-The `createPersistMiddleware()` parameters are:
-- the structure of your store and use arrays to define what values you want the middleware to persist
-- a save method
-- a load method
-- (optional) whether to enable debug or not
-
-The structure of your store consist of an object that takes some objects, and each object has to follow the following schema:
-
-- The key of each value in the persist object should match your store shape, a nested reducer would be defined as such: `data.device`.
-- In the `values` key, you can customize which values the package will keep track of. If nothing is provided to the `values` field, all fields will be saved.
-- A `key` is required to be defined for each persisted reducer, this will be used as the async storage key, it keeps a static map of your data which is independent of its shape, which is useful as your application grows.
-- An optional key of `action` can be defined to explicitly declare which action type should trigger a load of that reducer, without this value each load type is generated automatically from the state shape. e.g. to load `"data.device"` fire `LOAD_DATA_DEVICE`, to load `"subscriptionOrders"` fire `LOAD_SUBSCRIPTION_ORDERS`.
-- An optional `automatic` key can also be provided to specify if that reducer should be loaded automatically, without having to dispatch the action. It defaults to `true`.
-
-For the load and save method, you don't have to write them by yourself, they are [available as separate packages below](#providers).
+Firstly add the return value of `createPersistMiddleware` to your redux middleware. Then after creating your store, run the `createPersistMiddleware().run` method.
 
 ```js
 // e.g. save and load methods -> available as separate packages below
 const saveState = (key, state) => ...
 const loadState = (key) => ...
 
- /**
-  You define the structure that you want to save
-  in this object, and then pass it as an argument.
-  Instructions on how to create this object are above.
- */
+/**
+* You define the structure that you want to save
+* in this object, and then pass it as an argument.
+* Instructions on how to create this object are above.
+*/
 const structure = {
  orders: {
  values: ["data", "updatedAt", "index"],
@@ -69,8 +53,6 @@ const structure = {
  }
 };
 
-// store.js
-
 const persistMiddleware = createPersistMiddleware(
  structure, saveState, loadState
 )
@@ -80,15 +62,15 @@ export const store = createStore(
  reducers,
  applyMiddleware(...middleware)
 );
+
+// After setting the middleware in the store, you need to call `.run` and pass the store as an argument.
+persistMiddleware.run(store)
 ```
 
-Your reducer data will automatically saved when the values are changed. You can load each reducer using its load action (to see all the load actions generated in your console set the fourth parameter of `createPersistMachine` to `true`).
+For the load and save method, you don't have to write them by yourself, they are [available as separate packages below](#providers).
 
-After setting the middleware in the store, you need to call `createPersistMachine.run` and pass the store as an argument.
+Your reducer data will automatically saved when the values are changed. You can load each reducer using its load action (to see all the load actions generated in your console set the fourth parameter of `createPersistMachine` to `true`).
 
-```js
-createPersistMachine.run(store)
-```
 
 ### Loading Data
 
@@ -107,6 +89,31 @@ This allows you to have loading on a per reducer basis separated across the appl
 
 The middleware runs: `action.payload = { ...storedData, ...action.payload };` to add the saved data to the payload when the `LOAD_ACTION` is triggered. You can also pass additional data in your payload to add context to your `LOAD_ACTIONS` for complex conditional consummation of the loaded data in your reducers.
 
+## API Reference
+
+### `createPersistMiddleware(structure, saveState, loadState)`
+
+Creates a Redux persist middleware with your store structure.
+
+- `structure: Object` - A object to define how you want to load your reducer values. The key of each value in the persist object should match your store shape, a nested reducer would be defined as such: `data.device`. Currently supported options are:
+ - `values : Array` you can customize which values the package will keep track of. If nothing is provided to the `values` field, all fields will be saved.
+ - `key : string` this will be used as the storage key, it keeps a static map of your data which is independent of its shape, which is useful if your reducers change their structure or name.
+ - `action : string` defined to explicitly declare which action type should trigger a load of that reducer, without this value each load type is generated automatically from the state shape. e.g. to load `"data.device"` fire `@ReduxPM/LoadDataDevice`.
+ - `automatic : boolean` to specify if that reducer should be loaded automatically, without having to dispatch the action. It defaults to `true`.
+- `saveState : Function` - a save function with the following signature `(key, state) => void`
+- `loadState : Function` - a load function with the following signature `(key) => Object`
+
+### `createPersistMiddleware(structure, saveState, loadState).run(store)`
+
+Starts the persist middleware. You should run this immediately after creating your store.
+
+```js
+const persistMiddleware = createPersistMiddleware(structure, saveState, loadState)
+persistMiddleware.run(store)
+```
+
+- `store: [Store](https://redux.js.org/api/store)` the redux store.
+
 ## Providers
 
 Links for save and load functions for diffrent libraries and platforms.