update readme

build/index.js

@@ -17,6 +17,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; }
 
+// postRouter is a function that runs serverside
+// Its core function is to route all post requests passed to it based on the extracted data
 var postRouter = exports.postRouter = function () {
     var _ref = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(req, res, db, ObjectId) {
         var _req$body, collectionName, id, query, data, options, collection;
@@ -365,6 +367,7 @@ var postRouter = exports.postRouter = function () {
     };
 }();
 
+// query is a function responsible for sending query data to the server 
 var query = exports.query = function query() {
     var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : { baseURL: "", headers: {} };