node-ssh - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

package.json

 {
   "name": "node-ssh",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "SS2 with Promises",
@@ -5,0 +5,0 @@ "main": "Dist/SSH.js",

README.md

 Node-SSH - SSH2 with Promises
 =========
 
-Sorry, but I have no time to write the documentation, but this example should give you a clue on how it works.
+Node-SSH is an extremely lightweight Promise wrapper for [ssh2][ssh2], Period.
 
+#### Example
+
 ```js
@@ -46,1 +48,22 @@ var node_ssh, ssh;
 ```
+
+#### API
+
+```js
+type PutInfo = shape(LocalPath => string, RemotePath => string);
+class SSH{
+  constructor(SSH2Configuration);
+  connect():Promise<void>;
+  mkdir(Path:String):Promise<void>;
+  exec(Command:String, {cwd:String}):Promise<Object{stderr:String, stdout: String};>
+  put(LocalPath:String, RemotePath:String, ?SFTP: SSH2SFTP, ?Retry:Boolean = true):Promise<void>;
+  putMulti(Files:array<PutInfo>, ?SFTP: SSH2SFTP):Promise<void>;
+  get(RemoteFile:String, ?LocalFile:String, ?SFTP: SSH2SFTP):Promise<?string>;
+  requestSFTP():Promise<SSH2SFTP>
+}
+```
+
+### License
+This project is licensed under the terms of MIT license. See the LICENSE file for more info.
+
+[ssh2]:https://github.com/mscdex/ssh2

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13181

increased by5.46%

Number of lines in readme file

68

increased by47.83%

No dependency changes