ssh2-connect - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

CHANGELOG.md

 
 # Changelog
 
+## Version 2.0.3
+
+* readme: convert usage example to js
+
 ## Version 2.0.2
@@ -5,0 +9,0 @@

package.json

 {
   "name": "ssh2-connect",
   "description": "Callback-based api behind ssh2 to open an SSH connection",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "author": "David Worms <[e-mail]>",
@@ -6,0 +6,0 @@ "contributors": [],

README.md

@@ -15,11 +15,16 @@ [![Build Status](https://secure.travis-ci.org/adaltas/node-ssh2-connect.png)][travis]
 
-```coffee
-ssh2 = require 'ssh2'
-connection = new ssh2()
-connection.on 'error', (err) ->
-  connection.end()
-  # not ready at all
-connection.on 'ready', ->
-  # ready to go
-connection.connect options
+```js
+const ssh2 = require('ssh2')
+const connection = new ssh2()
+connection.on('error', function(err){
+  // not ready at all
+})
+connection.on('ready', function(){
+  // ready to go
+})
+connection.connect({
+  host: 'localhost',
+  user: 'milou',
+  password: 'wafwaf'
+})
 ```
@@ -29,6 +34,11 @@
 
-```coffee
-connect = require 'ssh2-exec/lib/connect'
-connect options, (err, ssh) ->
-  # this is faster to write
+```js
+const connect = require('ssh2-connect')
+connect({
+  host: 'localhost',
+  username: 'milou',
+  password: 'wafwaf'
+}, function(err, ssh){
+  // this is easier to write
+})
 ```
@@ -71,5 +81,7 @@
 ```js
-connect = require('ssh2-connect');
-fs = require('ssh2-fs');
+const connect = require('ssh2-connect');
+const fs = require('ssh2-fs');
+// Open the connection
 connect({host: 'localhost'}, function(err, ssh){
+  // Create a directory
   fs.mkdir(ssh, '/tmp/a_dir', (err, stdout, stderr){
@@ -76,0 +88,0 @@ console.log(stdout);

No alert changes

Improved metrics

Total package byte prevSize

10106

increased by2.52%

Number of lines in readme file

135

increased by9.76%

No dependency changes