Basic documentation

DivineOmega · Jul 31, 2019 · cb0aad2 · cb0aad2
1 parent f7ddd93
commit cb0aad2
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,23 @@
 # PHP SSH Connection
+
+## Installation
+
+```bash
+composer require divineomega/php-ssh-connection
+```
+
+## Usage
+
+````php
+$connection = (new SSHConnection())
+            ->to('test.rebex.net')
+            ->onPort(22)
+            ->as('demo')
+            ->withPassword('password')
+            ->connect();
+
+$command = $connection->run('echo "Hello world!"');
+
+$command->getOutput();  // 'Hello World'
+$command->getError();   // ''
+```