Merge branch 'master' of github.com:Einstore/ShellKit

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Einstore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,61 @@
+# ShellKit
+
+Access local shell as well as remote over SSH for Swift NIO applications
+
+### Install using SPM
+
+```swift
+.package(url: "https://github.com/Einstore/ShellKit.git", from: "1.0.0")
+```
+
+### Usage
+
+#### Connect to a local terminal
+
+```swift
+let shell = try Shell(.local, on: eventLoop)
+let futureResponse = shell.run(bash: "ls -a").map { output in
+   print(output)
+   return output
+}
+```
+
+#### Connect to a remote service
+
+```swift
+let shell = try Shell(
+    .ssh(
+        host: "1292.168.1.2",
+        username: "root",
+        password: "sup3rS3cr3t"
+    ),
+    on: eventLoop
+)
+let futureResponse = shell.run(bash: "ls -a")
+```
+
+> Other means of SSH authentication are available!
+
+#### Example
+
+```swift
+let eventLoop = EmbeddedEventLoop()
+let shell = try Shell(.local, on: eventLoop)
+let futureResponse = shell.run(bash: "cd /tmp/ ; pwd").map { output in
+   print(output)
+   return output
+}.flatMapError { error in
+   print(error)
+   return error.localizedDescription
+}
+let out: String = try futureResponse.wait()
+print(out)
+```
+
+### Author
+
+Ondrej Rafaj @rafiki270
+
+### License
+
+MIT; Copyright 2019 - Einstore