README update

Author: jkusachi

README.md

@@ -1,7 +1,7 @@
-redux-actions
+redux-actions-api-addon
 =============
 
-API Add on for [Flux Standard Action](https://github.com/acdlite/flux-standard-action) utilities for Redux.
+API Addon for [Flux Standard Action](https://github.com/acdlite/flux-standard-action) utilities for Redux.
 
 ```js
 npm install --save redux-actions
@@ -30,6 +30,7 @@ This add on attemps to solve 2 things:
 In order to be FSA Compliant, most of the information is stored in the `meta` object. 
 
 
+# The Simple Way (`{string} endpoint`)
 
 ### `createAPIAction(type, method, endpoint, payloadCreator = Identity, ?metaCreator)`
 
@@ -69,7 +70,7 @@ redux-actions will automatically set ```action.error``` to true.
 
 The following are **Verb Based Examples** so you can see how to use your actions
 
-##### GET 
+### GET 
 ```js
 let getItems = createAPIAction('ITEMS', 'GET', '/items' );
 getItems()
@@ -82,22 +83,27 @@ there is no need to pass a payload to your action, as its a `GET` request
 - `ITEMS_GET_SUCCESS`  
 - `ITEMS_GET_FAILURE`
 
-##### GET (single)
-```js
-let getSingleItem = createAPIAction('SINGLE_ITEM', 'GET', '/items' );
-getSingleItem(15)
+**Sample**  
 
+```json
+{
+  type: 'ITEMS',
+  payload: {},
+  meta: {
+    api: true,
+    method: 'GET',
+    endpoint: '/items',
+    types: [
+      'ITEMS_GET_REQUEST',
+      'ITEMS_GET_SUCCESS',
+      'ITEMS_GET_FAILURE'
+    ]
+  }
+}
 ```
-Here, we pass `15` as a parameter to the action, representing a case where we want only 1 item.
-It's also important to note that we used a separate key, `SINGLE_ITEM`, to differentiate between
-a single and All request.
 
-*Auto Generated Action Types*  
-- `SINGLE_ITEM_GET_REQUEST`  
-- `SINGLE_ITEM_GET_SUCCESS`  
-- `SINGLE_ITEM_GET_FAILURE`
 
-##### POST
+### POST
 
 ```js
 let createItem = createAPIAction('ITEMS', 'POST', '/items' );
@@ -111,7 +117,29 @@ Any data passed as the first parameter will be treated as the payload to be sent
 - `ITEMS_POST_SUCCESS`  
 - `ITEMS_POST_FAILURE`
 
-##### PUT
+**Sample**  
+
+```json
+{
+  type: 'ITEMS',
+  payload: {
+    name: "James Kusachi"
+  },
+  meta: {
+    api: true,
+    method: 'POST',
+    endpoint: '/sample',
+    types: [
+      'ITEMS_POST_REQUEST',
+      'ITEMS_POST_SUCCESS',
+      'ITEMS_POST_FAILURE'
+    ]
+  }
+}      
+```
+
+
+### PUT
 
 ```js
 let updateItem = createAPIAction('ITEMS', 'PUT', '/items' );
@@ -129,7 +157,28 @@ In this case, we are updating primary item `15` with a new object
 - `ITEMS_PUT_SUCCESS`  
 - `ITEMS_PUT_FAILURE`
 
-##### DELETE
+**Sample**  
+
+```json
+{
+  type: 'ITEMS',
+  payload: { 
+    name: 'james' 
+  },
+  meta: {
+    api: true,
+    method: 'PUT',
+    endpoint: '/sample/10',
+    types: [
+      'ITEMS_PUT_REQUEST',
+      'ITEMS_PUT_SUCCESS',
+      'ITEMS_PUT_FAILURE'
+    ]
+  }
+}      
+```
+
+### DELETE
 ```js
 let deleteItem = createAPIAction('ITEMS', 'DELETE', '/items' );
 updateItem(15);
@@ -143,3 +192,83 @@ No need to pass in any payload data, as that would get dropped anyways because o
 - `ITEMS_DELETE_SUCCESS`  
 - `ITEMS_DELETE_FAILURE`
 
+**Sample**  
+
+```json
+{
+  type: 'ITEMS',
+  payload: {},
+  meta: {
+    api: true,
+    method: 'DELETE',
+    endpoint: '/sample/5',
+    types: [
+      'ITEMS_DELETE_REQUEST',
+      'ITEMS_DELETE_SUCCESS',
+      'ITEMS_DELETE_FAILURE'
+    ]
+  }
+}
+```
+
+
+# Advanced (`{function} endpoint`)
+
+In cases where you need to customize the endpoint with more granularity, you can pass a `function` as the `endpoint` instead of a string. This gives you access to the payload so you can create dynamic endpoints based on the payload.
+
+NOTE: When using the Advanced method, you only need to send a payload across.  In the Simple version, parameter order is important (IE: for PUTs, first parameter is ID, second is payload, for POST the parameter is the payload).  
+
+For the advanced version, you only need to send the payload, and your endpoint will return dynamically based on your function.
+
+examples:  
+
+**GET Example**  
+
+```js
+const customEndpoint = (p) => {
+  return `/tester/${p}/mctesterson`;
+};
+
+const getItems = createAPIAction(type, 'GET', customEndpoint);
+
+getItems(10); //GET /tester/10/mctesterson
+
+```
+
+**POST Example**  
+
+```js
+const customEndpoint = (params) => {
+  return `/user/${params.id}/ronald/${params.name}`;
+};
+const createItem = createAPIAction(type, 'POST', customEndpoint);
+const payload = { id: 10, name: 'james' };
+
+createItem(payload); //POST /user/10/ronald/james
+```
+
+**PUT Example**  
+
+```js
+const customEndpoint = (params) => {
+  return `/user/${params.id}`;
+};
+const updateItem = createAPIAction(type, 'PUT', customEndpoint);
+const payload = { id: 10, name: 'james' };
+
+updateItem(payload); //PUT /user/10
+```
+
+**DELETE Example**  
+
+```js
+const customEndpoint = ({id, accountID}) => {
+  return `/user/${id}/account/${accountID}`;
+};
+const deleteItem = createAPIAction(type, 'DELETE', customEndpoint);
+const payload = { id: 10, accountID: 25 };
+
+deleteItem(payload); //DELETE /user/10/account/25
+```
+
+