Skip to content

Commit 0396d0b

Browse files
authored
Update README.md
1 parent 53d01ea commit 0396d0b

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Streaming UTF-8 parser for React PHP
88
* [Sequencer](#sequencer)
99
* [Install](#install)
1010
* [License](#license)
11+
* [More](#more)
1112

1213
> Note: This project is in beta stage! Feel free to report any issues you encounter.
1314
@@ -47,8 +48,8 @@ $stream = new Sequencer($stdin, 'X');
4748
As such, you can be sure you never get an invalid UTF-8 byte sequence out of
4849
the resulting stream.
4950

50-
Note that the stream may still contain ASCII/ANSI control characeters, as they're
51-
valid UTF-8.
51+
Note that the stream may still contain ASCII control characters or
52+
ANSI / VT100 control byte sequences, as they're valid UTF-8.
5253
This binary data will be left as-is, unless you filter this at a later stage.
5354

5455
## Install
@@ -67,3 +68,15 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
6768
## License
6869

6970
MIT
71+
72+
## More
73+
74+
* If you want to learn more about processing streams of data, refer to the documentation of
75+
the underlying [react/stream](https://github.com/reactphp/stream) component.
76+
77+
* If you want to process ASCII control characters or ANSI / VT100 control byte sequences, you may
78+
want to use [clue/term-react](https://github.com/clue/php-term-react) on the raw input
79+
stream before passing the resulting stream to the UTF-8 sequencer.
80+
81+
* If you want to to display or inspect the byte sequences, you may
82+
want to use [clue/hexdump](https://github.com/clue/php-hexdump) on the emitted byte sequences.

0 commit comments

Comments
 (0)