diff --git a/README.md b/README.md index 5a805ee..6e8ecf0 100644 --- 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(); // '' +``` \ No newline at end of file