diff --git a/CHANGELOG.md b/CHANGELOG.md index 34ca3b2..3d324f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,27 @@ # Changelog +## 2.2.0 (2018-09-03) + +* Feature / Fix: Accept CR as an alias for LF to support more platforms. + (#79 by @clue) + + The enter key will usually end the line with a `\n` (LF) + character on most Unix platforms. Common terminals also accept the + ^M (CR) key in place of the ^J (LF) key. + + By now allowing CR as an alias for LF in this library, we can significantly + improve compatibility with this common usage pattern and improve platform + support. In particular, some platforms use different TTY settings (`icrnl`, + `igncr` and family) and depending on these settings emit different EOL + characters. This fixes issues where enter was not properly + detected when using `ext-readline` on Mac OS X, Android and others. + +* Fix: Fix and simplify restoring TTY mode when `ext-readline` is not in use. + (#74 and #78 by @clue) + +* Update project homepage, minor code style improvements and sort dependencies. + (#72 and #81 by @clue and #75 by @localheinz) + ## 2.1.0 (2018-02-05) * Feature: Add support for binding custom functions to any key code diff --git a/README.md b/README.md index 01ed4e5..db20c84 100644 --- a/README.md +++ b/README.md @@ -588,11 +588,11 @@ ob_start(function ($chunk) use ($stdio) { The recommended way to install this library is [through Composer](https://getcomposer.org). [New to Composer?](https://getcomposer.org/doc/00-intro.md) -This project follows [SemVer](http://semver.org/). +This project follows [SemVer](https://semver.org/). This will install the latest supported version: ```bash -$ composer require clue/stdio-react:^2.1 +$ composer require clue/stdio-react:^2.2 ``` See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades. @@ -644,12 +644,16 @@ $ php vendor/bin/phpunit ## License -MIT +This project is released under the permissive [MIT license](LICENSE). + +> Did you know that I offer custom development services and issuing invoices for + sponsorships of releases and for contributions? Contact me (@clue) for details. ## More * If you want to learn more about processing streams of data, refer to the documentation of the underlying [react/stream](https://github.com/reactphp/stream) component. + * If you build an interactive CLI tool that reads a command line from STDIN, you may want to use [clue/arguments](https://github.com/clue/php-arguments) in order to split this string up into its individual arguments and then use