Skip to content

Commit 7efa40b

Browse files
authored
Update README.md
1 parent e905cd7 commit 7efa40b

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
[![Build Status](https://travis-ci.com/DivineOmega/php-ssh-connection.svg?branch=master)](https://travis-ci.com/DivineOmega/php-ssh-connection)
44
[![Coverage Status](https://coveralls.io/repos/github/DivineOmega/php-ssh-connection/badge.svg?branch=master)](https://coveralls.io/github/DivineOmega/php-ssh-connection?branch=master)
55

6+
The PHP SSH Connection package provides an elegant syntax to connect to SSH servers and execute commands. It supports both password and public-private keypair authentication, and can easily capture command output and errors.
7+
68
## Installation
79

10+
First, you may need to install the PHP SSH2 extension. In Ubuntu and other Debian-based systems, you can install this extension by running the following command.
11+
12+
```bash
13+
sudo apt install php-ssh2
14+
```
15+
16+
For other operating systems, see the [PHP SSH2 extension documentation](https://www.php.net/manual/en/book.ssh2.php).
17+
18+
You can then run the following Composer command to install the PHP SSH Connection package.
19+
820
```bash
921
composer require divineomega/php-ssh-connection
1022
```
@@ -24,4 +36,4 @@ $command = $connection->run('echo "Hello world!"');
2436

2537
$command->getOutput(); // 'Hello World'
2638
$command->getError(); // ''
27-
```
39+
```

0 commit comments

Comments
 (0)