Skip to content

Commit ec3d153

Browse files
authored
Merge pull request #30 from clue-labs/docs
Minor documentation improvements
2 parents 6c17119 + d13f137 commit ec3d153

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# clue/reactphp-ssh-proxy
22

33
[![CI status](https://github.com/clue/reactphp-ssh-proxy/workflows/CI/badge.svg)](https://github.com/clue/reactphp-ssh-proxy/actions)
4-
[![Packagist Downloads](https://img.shields.io/packagist/dt/clue/reactphp-ssh-proxy?color=blue)](https://packagist.org/packages/clue/reactphp-ssh-proxy)
4+
[![installs on Packagist](https://img.shields.io/packagist/dt/clue/reactphp-ssh-proxy?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/reactphp-ssh-proxy)
55

66
Async SSH proxy connector and forwarder, tunnel any TCP/IP-based protocol through an SSH server,
77
built on top of [ReactPHP](https://reactphp.org/).
@@ -72,7 +72,7 @@ Let's take these projects to the next level together! 🚀
7272
## Quickstart example
7373

7474
The following example code demonstrates how this library can be used to send a
75-
plaintext HTTP request to google.com through a remote SSH server:
75+
secure HTTPS request to google.com through a remote SSH server:
7676

7777
```php
7878
<?php
@@ -88,7 +88,7 @@ $connector = new React\Socket\Connector(array(
8888

8989
$browser = new React\Http\Browser($connector);
9090

91-
$browser->get('http://example.com/')->then(function (Psr\Http\Message\ResponseInterface $response) {
91+
$browser->get('https://google.com/')->then(function (Psr\Http\Message\ResponseInterface $response) {
9292
var_dump($response->getHeaders(), (string) $response->getBody());
9393
}, function (Exception $e) {
9494
echo 'Error: ' . $e->getMessage() . PHP_EOL;
@@ -358,7 +358,7 @@ $connector = new React\Socket\Connector(array(
358358

359359
$browser = new React\Http\Browser($connector);
360360

361-
$browser->get('http://example.com/')->then(function (Psr\Http\Message\ResponseInterface $response) {
361+
$browser->get('https://google.com/')->then(function (Psr\Http\Message\ResponseInterface $response) {
362362
var_dump($response->getHeaders(), (string) $response->getBody());
363363
}, function (Exception $e) {
364364
echo 'Error: ' . $e->getMessage() . PHP_EOL;
@@ -568,7 +568,7 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
568568
This project aims to run on any platform and thus does not require any PHP
569569
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
570570
HHVM.
571-
It's *highly recommended to use PHP 7+* for this project.
571+
It's *highly recommended to use the latest supported PHP version* for this project.
572572

573573
This project is implemented as a lightweight process wrapper around the `ssh`
574574
client binary, so you'll have to make sure that you have a suitable SSH client
@@ -586,7 +586,7 @@ Debian/Ubuntu-based systems, you may simply install it like this:
586586
$ sudo apt install sshpass
587587
```
588588

589-
*Running on [Windows is currently not supported](https://github.com/reactphp/child-process/issues/9)*
589+
*Running on [Windows is currently not supported](https://github.com/clue/reactphp-ssh-proxy/issues/12)*
590590

591591
## Tests
592592

0 commit comments

Comments
 (0)