Add comments and install jsdocs

.gitignore

@@ -36,6 +36,7 @@ build/Release
 node_modules/
 jspm_packages/
 .vscode/
+out/
 
 # Typescript v1 declaration files
 typings/

README.md

@@ -4,7 +4,6 @@
 [![Coverage Status](https://coveralls.io/repos/github/daern91/build-actions/badge.svg?branch=master)](https://coveralls.io/github/daern91/build-actions?branch=master)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-
 A small library to diff Customers and build update actions.
 
 ## Installation
@@ -25,13 +24,14 @@ Execute these commands in the project's root directory:
 
 * `npm run generate-data` - Generate a data.json file with test customers.
 * Duplicate the data.json file and change some of the customer info in the new copy, e.g. `email`.
-* `clitest import --file testCustomers/<newFileName.json>`
+* `buildactions import --file testCustomers/<newFileName.json>`
 
 ## Setup (npm)
 
 `npm install @daern91/build-actions`
 
 ## Usage
+
 ```javascript
 const buildActions = require('@daern91/build-actions');
 
@@ -40,9 +40,12 @@ const actions = buildActions(oldCustomerObject, newCustomerObject);
 // Output should be an array of update actions
 ```
 
+**NOTE: You may also use CLI by installing package globally with `npm install @daern91/build-actions -g`**
+
 ## Tests
 
-* `npm test` or `npm run cover` for full testing including coverage.
+* `npm test` for full testing including lint.
+* `npm run cover` for full testing including coverage.
 
 ### Requirements
 

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@daern91/build-actions",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "description": "",
   "main": "src/index.js",
   "bin": {
-    "clitest": "bin/cli.js"
+    "buildactions": "bin/cli.js"
   },
   "scripts": {
     "test": "standard && mocha --reporter spec",
@@ -34,6 +34,7 @@
     "faker": "^4.1.0",
     "husky": "^0.14.3",
     "istanbul": "^0.4.5",
+    "jsdoc": "^3.5.5",
     "lint-staged": "^6.1.0",
     "make-dir": "^1.1.0",
     "mocha": "^5.0.0",

src/buildActions.js

@@ -11,9 +11,7 @@ function getActionType (oldValue, newValue, isDeleted) {
   } else if (!_.isNil(oldValue) && !_.isNil(newValue)) {
     return 'change'
   } else {
-    throw new Error(
-      'Incorrect data type (Object value should be crowded string).'
-    )
+    throw new Error('Incorrect data type')
   }
 }
 
@@ -25,6 +23,8 @@ function getActionFromDiff (diff, field) {
   if (field.indexOf('address') >= 0 && operation === 'set') {
     operation = 'add'
   }
+
+  // TODO: Add rest of allowed calls from docs
   const allowedFields = [
     'firstName',
     'lastName',