Improve documentation and examples

clue · Feb 13, 2024 · 11adadd · 11adadd
1 parent 00f297d
commit 11adadd
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -36,9 +36,13 @@ It wraps a given `ReadableStreamInterface` and exposes its plain data through
 the same interface.
 
 ```php
+<?php
+
+require __DIR__ . '/vendor/autoload.php';
+
 $stdin = new React\Stream\ReadableResourceStream(STDIN);
 
-$stream = new ControlCodeParser($stdin);
+$stream = new Clue\React\Term\ControlCodeParser($stdin);
 
 $stream->on('data', function ($chunk) {
     var_dump($chunk);

diff --git a/examples/random-colors.php b/examples/random-colors.php
@@ -11,10 +11,6 @@
 // with random colors:
 // $ phpunit --color=always | php random-colors.php
 
-use Clue\React\Term\ControlCodeParser;
-use React\Stream\ReadableResourceStream;
-use React\Stream\WritableResourceStream;
-
 require __DIR__ . '/../vendor/autoload.php';
 
 if (function_exists('posix_isatty') && posix_isatty(STDIN)) {
@@ -23,10 +19,10 @@
 }
 
 // process control codes from STDIN
-$stdin = new ReadableResourceStream(STDIN);
-$parser = new ControlCodeParser($stdin);
+$stdin = new React\Stream\ReadableResourceStream(STDIN);
+$parser = new Clue\React\Term\ControlCodeParser($stdin);
 
-$stdout = new WritableResourceStream(STDOUT);
+$stdout = new React\Stream\WritableResourceStream(STDOUT);
 
 // pass all c0 codes through to output
 $parser->on('c0', array($stdout, 'write'));

diff --git a/examples/remove-codes.php b/examples/remove-codes.php
@@ -8,10 +8,6 @@
 // codes like this:
 // $ phpunit --color=always | php remove-codes.php
 
-use Clue\React\Term\ControlCodeParser;
-use React\Stream\ReadableResourceStream;
-use React\Stream\WritableResourceStream;
-
 require __DIR__ . '/../vendor/autoload.php';
 
 if (function_exists('posix_isatty') && posix_isatty(STDIN)) {
@@ -20,11 +16,11 @@
 }
 
 // process control codes from STDIN
-$stdin = new ReadableResourceStream(STDIN);
-$parser = new ControlCodeParser($stdin);
+$stdin = new React\Stream\ReadableResourceStream(STDIN);
+$parser = new Clue\React\Term\ControlCodeParser($stdin);
 
 // pipe data from STDIN to STDOUT without any codes
-$stdout = new WritableResourceStream(STDOUT);
+$stdout = new React\Stream\WritableResourceStream(STDOUT);
 $parser->pipe($stdout);
 
 // only forward \r, \n and \t

diff --git a/examples/stdin-codes.php b/examples/stdin-codes.php
@@ -9,9 +9,6 @@
 // codes like this:
 // $ phpunit --color=always | php stdin-codes.php
 
-use Clue\React\Term\ControlCodeParser;
-use React\Stream\ReadableResourceStream;
-
 require __DIR__ . '/../vendor/autoload.php';
 
 if (function_exists('posix_isatty') && posix_isatty(STDIN)) {
@@ -20,8 +17,8 @@
 }
 
 // process control codes from STDIN
-$stdin = new ReadableResourceStream(STDIN);
-$parser = new ControlCodeParser($stdin);
+$stdin = new React\Stream\ReadableResourceStream(STDIN);
+$parser = new Clue\React\Term\ControlCodeParser($stdin);
 
 $decoder = function ($code) {
     echo 'Code:';