Skip to content

Commit

Permalink
Prepare v2.2.0 release
Browse files Browse the repository at this point in the history
clue committed Sep 3, 2018
1 parent 8b1219a commit 43d24e4
Showing 2 changed files with 29 additions and 3 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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 <kbd>enter</kbd> key will usually end the line with a `\n` (LF)
character on most Unix platforms. Common terminals also accept the
<kbd>^M</kbd> (CR) key in place of the <kbd>^J</kbd> (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 <kbd>enter</kbd> 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
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 43d24e4

Please sign in to comment.