Skip to content

Commit 11adadd

Browse files
committed
Improve documentation and examples
1 parent 00f297d commit 11adadd

File tree

4 files changed

+13
-20
lines changed

4 files changed

+13
-20
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,13 @@ It wraps a given `ReadableStreamInterface` and exposes its plain data through
3636
the same interface.
3737

3838
```php
39+
<?php
40+
41+
require __DIR__ . '/vendor/autoload.php';
42+
3943
$stdin = new React\Stream\ReadableResourceStream(STDIN);
4044

41-
$stream = new ControlCodeParser($stdin);
45+
$stream = new Clue\React\Term\ControlCodeParser($stdin);
4246

4347
$stream->on('data', function ($chunk) {
4448
var_dump($chunk);

examples/random-colors.php

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@
1111
// with random colors:
1212
// $ phpunit --color=always | php random-colors.php
1313

14-
use Clue\React\Term\ControlCodeParser;
15-
use React\Stream\ReadableResourceStream;
16-
use React\Stream\WritableResourceStream;
17-
1814
require __DIR__ . '/../vendor/autoload.php';
1915

2016
if (function_exists('posix_isatty') && posix_isatty(STDIN)) {
@@ -23,10 +19,10 @@
2319
}
2420

2521
// process control codes from STDIN
26-
$stdin = new ReadableResourceStream(STDIN);
27-
$parser = new ControlCodeParser($stdin);
22+
$stdin = new React\Stream\ReadableResourceStream(STDIN);
23+
$parser = new Clue\React\Term\ControlCodeParser($stdin);
2824

29-
$stdout = new WritableResourceStream(STDOUT);
25+
$stdout = new React\Stream\WritableResourceStream(STDOUT);
3026

3127
// pass all c0 codes through to output
3228
$parser->on('c0', array($stdout, 'write'));

examples/remove-codes.php

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@
88
// codes like this:
99
// $ phpunit --color=always | php remove-codes.php
1010

11-
use Clue\React\Term\ControlCodeParser;
12-
use React\Stream\ReadableResourceStream;
13-
use React\Stream\WritableResourceStream;
14-
1511
require __DIR__ . '/../vendor/autoload.php';
1612

1713
if (function_exists('posix_isatty') && posix_isatty(STDIN)) {
@@ -20,11 +16,11 @@
2016
}
2117

2218
// process control codes from STDIN
23-
$stdin = new ReadableResourceStream(STDIN);
24-
$parser = new ControlCodeParser($stdin);
19+
$stdin = new React\Stream\ReadableResourceStream(STDIN);
20+
$parser = new Clue\React\Term\ControlCodeParser($stdin);
2521

2622
// pipe data from STDIN to STDOUT without any codes
27-
$stdout = new WritableResourceStream(STDOUT);
23+
$stdout = new React\Stream\WritableResourceStream(STDOUT);
2824
$parser->pipe($stdout);
2925

3026
// only forward \r, \n and \t

examples/stdin-codes.php

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@
99
// codes like this:
1010
// $ phpunit --color=always | php stdin-codes.php
1111

12-
use Clue\React\Term\ControlCodeParser;
13-
use React\Stream\ReadableResourceStream;
14-
1512
require __DIR__ . '/../vendor/autoload.php';
1613

1714
if (function_exists('posix_isatty') && posix_isatty(STDIN)) {
@@ -20,8 +17,8 @@
2017
}
2118

2219
// process control codes from STDIN
23-
$stdin = new ReadableResourceStream(STDIN);
24-
$parser = new ControlCodeParser($stdin);
20+
$stdin = new React\Stream\ReadableResourceStream(STDIN);
21+
$parser = new Clue\React\Term\ControlCodeParser($stdin);
2522

2623
$decoder = function ($code) {
2724
echo 'Code:';

0 commit comments

Comments
 (0)