Skip to content

Commit 5f220c8

Browse files
authored
Update README.md
1 parent 17c3f6e commit 5f220c8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Streaming terminal emulator, built on top of React PHP
88
* [ControlCodeParser](#controlcodeparser)
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
@@ -115,3 +116,21 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
115116
## License
116117

117118
MIT
119+
120+
## More
121+
122+
* If you want to learn more about processing streams of data, refer to the documentation of
123+
the underlying [react/stream](https://github.com/reactphp/stream) component.
124+
125+
* If you want to process UTF-8 encoded console input, you may
126+
want to use [clue/utf8-react](https://github.com/clue/php-utf8-react) on the resulting
127+
plain data stream.
128+
129+
* If you want to to display or inspect the control codes, you may
130+
want to use either [clue/hexdump](https://github.com/clue/php-hexdump) or
131+
[clue/caret-notation](https://github.com/clue/php-caret-notation) on the emitted
132+
control byte sequences.
133+
134+
* If you want to process standard input and output (STDIN and STDOUT) from a TTY, you may
135+
want to use [clue/stdio-react](https://github.com/clue/php-stdio-react) instead of
136+
using this low-level library.

0 commit comments

Comments
 (0)