Readme completed.

README.md

@@ -1,9 +1,179 @@
 # API Standard JResponse
-This library aim to standardize the JSON responses of your REST API application. Make your font-end developer life easier.
+This library aim to standardize the JSON responses of your REST API application. 
+Make your font-end developer life easier.
 
-## Some details
- - NodeJS6 (or above) required
- - No dependencies
- - 6-years-old child ready 
+## Requirements
+ - NodeJS8 (or above)
 
+## Installation
+```
+npm i api-standard-jresponse
+```
+## Standard Response
+```json
+{
+    "success": true, // or false
+    "count": 0, // length of the data array
+    "data": [], // array of data
+    "errors": [] // array of errors
+}
+```
+***Notice:*** "data" and "error" fields are always array. This makes the communication easier because the client 
+knows that regardless of the type of received data, he will always get an array at that point.  
+
+## Usages
+### Basic usage (Static function)
+methods:
+- `JResponse.success(response_obj, data, [,status]);` If not specified, default status is ***200***. Data can be number/string/object or even an array of values. 
+- `JResponse.errors(response_obj, errors, [,status]);` If not specified, default status is ***400***. Errors ca be number/string/object or even an array of values.
+```javascript
+import { JResponse } from "api-standard-jresponse";
+
+app.get("/introduce/yourself", (req, res) => {
+    try {
+        // Do your staff
+
+        return JResponse.success(res, "Hello, my name is John Doe.");
+    } catch (e) {
+        return JResponse.errors(res, e.message);  
+    }
+});
+
+```
+### Dynamic usage
+This allow you to dynamically append data or error during the execution of the code.
+
+Firs of all, add the response setter middleware (before declaring any routes).
+```javascript
+import { setJResponse } from "api-standard-jresponse";
+
+app.use(setJResponse);
+```
+This middleware attach to the response object an instance of the class.
+Now, just use the custom property ***res.JRes ...*** instead of ***res.json***
+
+success methods:
+- `res.JRes.appendData(data, [,status]);` ***This method does not print anything.*** Just append data to the payload. [data] will be sent by the following method.
+- `res.JRes.sendSuccess([,data], [,status]);` ***This method print data.*** [data] can be number/string/object or even an array of values. Prints the entire payload of previously added data, merged with the one passed to this function (if passed). 
+
+error methods:
+- `res.JRes.appendError(error, [,status]);` ***This method does not print any error.*** Just append the error to the payload. [error] can be number/string/object or even an array of values.
+- `res.JRes.sendErrors([,error], [,status]);` ***This method print errors.*** [error] can be number/string/object or even an array of values. Prints the entire payload of error previously added merged with the one passed to this function.
+
+example:
+```javascript
+ app.get("/people/list", (req, res) => {
+     try {
+         // Do your staffs
+         res.JRes.appendData( 
+                     { 
+                        "first_name": "John",      
+                        "last_name": "Doe"      
+                     } 
+                 );
+         // Do other staffs
+         res.JRes.appendData( 
+                     {
+                        "first_name": "Floyd",      
+                        "last_name": "Earls"      
+                     } 
+                  );
+
+
+         return res.JRes.sendSuccess();
+         // or return res.JRes.sendSuccess({"first_name": "Nelson", "last_name": "Pate"});
+     } catch (e) {
+         res.JRes.appendError(getMessage(e));
+         res.JRes.appendError(getJsonTrace(e));
+         return res.JRes.sendErrors();   
+         // or just res.JRes.sendErrors(e.message);
+     }
+ });    
 
+function getMessage(e) {
+    return e.message;
+}
+function getJsonTrace(e) {
+    // build trace
+    return trace_obj;
+}
+```
+## Success Response
+```json
+{
+    "success": true,
+    "count": 3,
+    "data": [
+      {
+        "first_name": "John",      
+        "last_name": "Doe"      
+      },{
+        "first_name": "Floyd",      
+        "last_name": "Earls"      
+      },{
+        "first_name": "Nelson",      
+        "last_name": "Pate"      
+      }
+    ],
+    "errors": []
+}
+```
+or
+```json
+{
+    "success": true,
+    "count": 1,
+    "data": [
+      "Congratulation, everything is ok!"
+    ],
+    "errors": []
+}
+```
+or even
+```json
+{
+    "success": true,
+    "count": 0,
+    "data": [],
+    "errors": []
+}
+```
+## Error Response
+```json
+{
+    "success": false,
+    "count": 0,
+    "data": [],
+    "errors": [
+      {
+        "message": "Validation error.",
+      },
+      {
+        "trace": [
+          "first_name is required.",
+          "last_name is required."
+        ]
+      }
+    ]
+}
+```
+or
+```json
+{
+    "success": false,
+    "count": 0,
+    "data": [],
+    "errors": [
+      "Something went wrong."
+    ]
+}
+```
+or even
+```json
+{
+    "success": false,
+    "count": 0,
+    "data": [],
+    "errors": []
+}
+```