Skip to content

Commit 27bd1e7

Browse files
committed
Improve documentation and minor clean up
1 parent 000b040 commit 27bd1e7

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
/vendor/
21
/composer.lock
2+
/vendor/

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,11 @@ It wraps a given `ReadableStreamInterface` and exposes its data through the same
3535
interface.
3636

3737
```php
38-
$stdin = new ReadableResourceStream(STDIN, $loop);
38+
<?php
39+
40+
require __DIR__ . '/vendor/autoload.php';
41+
42+
$stdin = new ReadableResourceStream(STDIN);
3943

4044
$stream = new Sequencer($stdin);
4145

@@ -67,7 +71,7 @@ This binary data will be left as-is, unless you filter this at a later stage.
6771

6872
## Install
6973

70-
The recommended way to install this library is [through Composer](https://getcomposer.org).
74+
The recommended way to install this library is [through Composer](https://getcomposer.org/).
7175
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
7276

7377
This project follows [SemVer](https://semver.org/).
@@ -82,12 +86,12 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
8286
This project aims to run on any platform and thus does not require any PHP
8387
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
8488
HHVM.
85-
It's *highly recommended to use PHP 7+* for this project.
89+
It's *highly recommended to use the latest supported PHP version* for this project.
8690

8791
## Tests
8892

8993
To run the test suite, you first need to clone this repo and then install all
90-
dependencies [through Composer](https://getcomposer.org):
94+
dependencies [through Composer](https://getcomposer.org/):
9195

9296
```bash
9397
$ composer install
@@ -96,7 +100,7 @@ $ composer install
96100
To run the test suite, go to the project root and run:
97101

98102
```bash
99-
$ php vendor/bin/phpunit
103+
$ vendor/bin/phpunit
100104
```
101105

102106
## License

src/Sequencer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
use Evenement\EventEmitter;
66
use React\Stream\ReadableStreamInterface;
7-
use React\Stream\WritableStreamInterface;
87
use React\Stream\Util;
8+
use React\Stream\WritableStreamInterface;
99

1010
/**
1111
* forwards only complete UTF-8 sequences

0 commit comments

Comments
 (0)