Update readme 📘

Author: vladimyr

README.md

@@ -1,6 +1,84 @@
-
 # Deploy system for PM2
 
-Documentation: [https://pm2.io/doc/en/runtime/guide/easy-deploy-with-ssh/](https://pm2.io/doc/en/runtime/guide/easy-deploy-with-ssh/)
+Documentation: <https://pm2.io/doc/en/runtime/guide/easy-deploy-with-ssh/>
 
 [![build status](https://badgen.net/travis/Unitech/pm2/master)](https://travis-ci.org/Unitech/pm2-deploy) [![npm package version](https://badgen.net/npm/v/pm2-deploy)](https://npm.im/pm2-deploy) [![install size](https://badgen.net/packagephobia/install/pm2-deploy)](https://packagephobia.now.sh/result?p=pm2-deploy) [![github license](https://badgen.net/github/license/Unitech/pm2-deploy)](https://github.com/Unitech/pm2-deploy/blob/master/LICENSE) [![js semistandard style](https://badgen.net/badge/code%20style/semistandard/pink)](https://github.com/Flet/semistandard)
+
+## Instalation
+
+    $ npm install pm2-deploy
+
+## Usage
+
+```js
+var deployForEnv = require('pm2-deploy').deployForEnv;
+
+// Define deploy configuration with target environments
+var deployConfig = {
+  prod: {
+    user: 'node',
+    host: '212.83.163.168',
+    ref: 'origin/master',
+    repo: 'git@github.com:Unitech/eip-vitrine.git',
+    path: '/var/www/test-deploy'
+  },
+  dev: {
+    user: 'node',
+    host: '212.83.163.168',
+    ref: 'origin/master',
+    repo: 'git@github.com:Unitech/eip-vitrine.git',
+    path: '/var/www/test-dev'
+  }
+};
+
+// Invoke deployment for `dev` environment
+deployForEnv(deployConfig, 'dev', [], function (err, args) {
+  if (err) {
+    console.error('Deploy failed:', err.message);
+    return console.error(err.stack);
+  }
+  console.log('Success!');
+});
+
+// Rollback `prod` environment
+deployForEnv(deployConfig, 'prod', ['revert', 1], function (err, args) {
+  if (err) {
+    console.error('Rollback failed:', err.message);
+    return console.error(err.stack);
+  }
+  console.log('Success!');
+});
+```
+
+## API
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+#### Table of Contents
+
+-   [deployForEnv](#deployforenv)
+    -   [Parameters](#parameters)
+-   [DeployCallback](#deploycallback)
+    -   [Parameters](#parameters-1)
+
+### deployForEnv
+
+Deploy to a single environment
+
+#### Parameters
+
+-   `deployConfig` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object containing deploy configs for all environments
+-   `env` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the environment to deploy to
+-   `args` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** custom deploy command-line arguments
+-   `cb` **[DeployCallback](#deploycallback)** done callback
+
+Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** return value is always `false`
+
+### DeployCallback
+
+Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
+
+#### Parameters
+
+-   `error` **[Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** deployment error
+-   `args` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** custom command-line arguments provided to deploy

deploy.js

@@ -33,17 +33,11 @@ var schema = {
   required: ['host', 'repo', 'path', 'ref'],
 };
 
-/**
- * @callback DeployCallback
- * @param {Error} error deployment error
- * @param {array} args custom command-line arguments provided to deploy
- */
-
 /**
  * Spawn a modified version of visionmedia/deploy
  * @private
  * @param {object} config config to be piped to deploy
- * @param {array}  [args] custom deploy command-line arguments
+ * @param {array}  args custom deploy command-line arguments
  * @param {DeployCallback} cb done callback
  */
 function spawn(config, args, cb) {
@@ -84,9 +78,9 @@ function castArray(arg) {
  * Deploy to a single environment
  * @param {object} deployConfig object containing deploy configs for all environments
  * @param {string} env the name of the environment to deploy to
- * @param {array} [args] custom deploy command-line arguments
+ * @param {array} args custom deploy command-line arguments
  * @param {DeployCallback} cb done callback
- * @returns {boolean} always returns false
+ * @returns {boolean} return value is always `false`
  */
 function deployForEnv(deployConfig, env, args, cb) {
   if (!deployConfig[env]) {
@@ -160,3 +154,9 @@ function prependEnv(cmd, env) {
 module.exports = {
   deployForEnv: deployForEnv,
 };
+
+/**
+* @callback DeployCallback
+* @param {Error} error deployment error
+* @param {array} args custom command-line arguments provided to deploy
+*/

package.json

@@ -16,14 +16,16 @@
   },
   "scripts": {
     "lint": "eslint \"**/*.js\"",
-    "test": "mocha"
+    "test": "mocha",
+    "docs": "documentation readme ./deploy.js --section=API"
   },
   "dependencies": {
     "run-series": "^1.1.8",
     "tv4": "^1.3.0"
   },
   "devDependencies": {
     "better-assert": "^1.0.2",
+    "documentation": "^11.0.0",
     "eslint": "^5.16.0",
     "eslint-config-semistandard": "^13.0.0",
     "eslint-config-standard": "^12.0.0",