Update documentation and prepare for release 0.1.1

Author: Gormartsen

README.md

@@ -82,6 +82,14 @@ host = {
    //stream object used  to respond to the timeout without having to close the connection
    //connection object gives access to close the shell using connection.end()
   },
+  onError: function ( err, type, close ) {
+   //optional code for responding to error
+  },
+  onClose: function (  has_error, command ) {
+   //optional code for responding to close 
+   // has_error: boolean. True if error hapen
+   // command: latest command that was processing when connection get closed.
+  },
   onEnd:               function( notices, sshObj ) {
    //optional code to run at the end of the session
    //notices is array of all notices for each command.
@@ -147,34 +155,39 @@ dotenv.load();
 var Email = require('email');
 
 var host = {
- server:              {     
-  host:         process.env.HOST,
-  port:         process.env.PORT,
-  userName:     process.env.USER_NAME,
-  password:     process.env.PASSWORD,
-  passPhrase:   process.env.PASS_PHRASE,
-  privateKey:   require('fs').readFileSync(process.env.PRIV_KEY_PATH)
- },
- commands:      [
-  "echo $(pwd)",
-  "cd ~/",
-  "ls -l",
-  "echo $(pwd)",
-  "ls -l",
- ],
- onCommandComplete: function( notice, sshObj ) {
-  //confirm it is the root home dir and change to root's .ssh folder
-  if (notice.command === "echo $(pwd)" && notice.output.indexOf("/root") != -1 ) {
-   sshObj.commands.push("cd .ssh");
-  }
-  //we are listing the dir so output it to the msg handler
-  else if (notice.command === "ls -l"){      
-   console.log(notice.output);
+  server:              {     
+    host:         process.env.HOST,
+    port:         process.env.PORT,
+    userName:     process.env.USER_NAME,
+    password:     process.env.PASSWORD,
+    passPhrase:   process.env.PASS_PHRASE,
+    privateKey:   require('fs').readFileSync(process.env.PRIV_KEY_PATH)
+  },
+  commands:      [
+    "echo $(pwd)",
+    "cd ~/",
+    "ls -l",
+    "echo $(pwd)",
+    "ls -l",
+  ],
+  onCommandComplete: function( notice, sshObj ) {
+    //confirm it is the root home dir and change to root's .ssh folder
+    if (notice.command === "echo $(pwd)" && notice.output.indexOf("/root") != -1 ) {
+     sshObj.commands.push("cd .ssh");
+    }
+    //we are listing the dir so output it to the msg handler
+    else if (notice.command === "ls -l"){      
+     console.log(notice.output);
+    }
+  },
+  onClose: function( has_error, command ) {
+    //has_error is true if session has bin interrupted.
+    //command is latest command that was processing and did not finish.
+    console.log(command);
+  },
+  onEnd: function( notices, sshObj ) {
+    console.log(notices);
   }
- },
- onEnd: function( notices, sshObj ) {
-   console.log(notices);
- }
 };
 
 //Create a new instance

package.json

@@ -1,6 +1,6 @@
 {
   "name": "zenci-shell",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "Gormartsen",
   "description": "A wrapper class for node.js ssh2 to run multiple commands.",
   "main": "./zenci-shell.js",
@@ -19,8 +19,6 @@
     "server",
     "multiple",
     "commands",
-    "tunnel",
-    "tunnelling",
     "deploy",
     "automation"
   ],
@@ -36,4 +34,4 @@
     "test": "test"
   },
   "license": "MIT"
-}
+}