Merge pull request #12 from leapfrogtechnology/readme-fix

Minor improvements on the documentation

Author: mesaugat

README.md

@@ -28,50 +28,51 @@ yarn add @leapfrogtechnology/async-store
 ```js
 const store = require('@leapfrogtechnology/async-store');
 
+store.initialize()(callback);
+
 function callback() {
-  store({ foo: 'Hello', bar: 'World' });
+  store.set({ foo: 'Hello', bar: 'World' });
 
   Promise.resolve()
     .then(() => {
       console.log('Value of foo: ', store.get('foo'));
     })
     .then(() => {
-      console.log('Value of foo: ', store.get('foo'));
+      console.log('Value of bar: ', store.get('bar'));
     })
     .then(() => {
       console.log('Value of foo: ', store.get('foo'));
     })
     .then(() => {
-      // Store value is available at the end of the promise chain.
-      console.log('Value of foo: ', store.get('foo'));
+      console.log('Value of bar: ', store.get('bar'));
     });
 }
-
-store.initialize()(callback);
 ```
 
 ### TypeScript Example
 
 ```js
 import * as store from '@leapfrogtechnology/async-store';
 
+store.initialize()(callback);
+
 function callback() {
-  store({ foo: 'Hello', bar: 'World' });
+  store.set({ foo: 'Hello', bar: 'World' });
 
   Promise.resolve()
     .then(() => {
       console.log('Value of foo: ', store.get('foo'));
     })
     .then(() => {
-      console.log('Value of foo: ', store.get('foo'));
+      console.log('Value of bar: ', store.get('bar'));
     })
     .then(() => {
-      // Store value is available at the end of the promise chain.
       console.log('Value of foo: ', store.get('foo'));
+    })
+    .then(() => {
+      console.log('Value of bar: ', store.get('bar'));
     });
 }
-
-store.initialize()(callback);
 ```
 
 ### Express Example
@@ -95,7 +96,7 @@ app.use((req, res, next) => {
 // Get request Id from store
 app.get('/', (req, res) => {
   const reqId = store.get('reqId');
-  console.log(`[${reqId}]`);
+  console.log(`Request Id: ${reqId}`);
 
   res.json({ message: 'Hello World' });
 });
@@ -109,12 +110,29 @@ app.listen(port, () => console.log(`Example app listening on port ${port}!`));
 
 ## API Docs
 
+### initialize()
+
+Initialize the async store based on the adapter provided.
+
+ - `@param {AsyncStoreAdapter} [adapter=AsyncStoreAdapter.DOMAIN]` - Async store adapter to use.
+ - `@returns {(params: AsyncStoreParams) => void}` - Returns a function that takes a callback which will be triggered once the store has been initialized.
+
+```js
+const store = require('@leapfrogtechnology/async-store');
+
+store.initialize()(callback);
+
+function callback() {
+  // Do something with the store. 
+}
+```
+
 ### initializeMiddleware()
 
 Middleware to initialize the async store and make it accessible from all the subsequent middlewares or async operations triggered afterwards.
 
-- `@param {AsyncStoreAdapter} [adapter=AsyncStoreAdapter.DOMAIN]`: Store adapter.
-- `@returns {(req, res, next) => void}`
+- `@param {AsyncStoreAdapter} [adapter=AsyncStoreAdapter.DOMAIN]` - Async store adapter to use.
+- `@returns {(req, res, next) => void}` - Returns the express middleware function.
 
 ```js
 const express = require('express');
@@ -126,9 +144,9 @@ app.use(store.initializeMiddleware());
 
 ### set()
 
-It sets properties in the store.
+Persists properties in the store.
 
-- `@params {any} properties`: Properties to set in store.
+- `@params {any} properties` - Persist properties to set in store.
 - `@returns {void}`
 
 ```js
@@ -137,21 +155,21 @@ store.set({ foo: 'Hello', bar: 'World' });
 
 ### get()
 
-It gets a value by a key from the store.
+Gets a value by a key from the store.
 
-- `@params {string} key`: Key specifies property of store.
-- `@returns {any}`
+- `@params {string} key` -  Key to get from the store. 
+- `@returns {any}` - Returns the value persisted in the store by `key` which could be `null` if key not found. Any error caught during the retrieval will be thrown and cascaded.
 
 ```js
 const foo = store.get('foo');
 ```
 
 ### find()
 
-It gets a value by a key from the store. If anything fails, it returns null without emitting error event.
+Gets a value by a key from the store. If anything fails, it returns `null` without emitting error event.
 
-- `@params {string} key`: Key specifies property of store.
-- `@returns {any}`
+- `@params {string} key` - Key to get from the store. 
+- `@returns {any}` - Returns the value persisted in the store by `key` which could be `null` if key not found. Any error caught during the retrieval will be supressed and `null` value is returned.
 
 ```js
 const foo = store.find('foo');