Prepare v2.0.0 release

Author: clue

CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 2.0.0 (2017-09-20)
+
+A major compatibility release to update this package to support all latest
+ReactPHP components!
+
+This update involves a minor BC break due to dropped support for legacy
+versions. We've tried hard to avoid BC breaks where possible and minimize impact
+otherwise. We expect that most consumers of this package will actually not be
+affected by any BC breaks, see below for more details.
+
+*   BC break: Remove all deprecated APIs (individual `Stdin`, `Stdout`, `line` etc.)
+    (#64 and #68 by @clue)
+
+    >   All of this affects only what is considered "advanced usage".
+        If you're affected by this BC break, then it's recommended to first
+        update to the intermediary v1.2.0 release, which provides alternatives
+        to all deprecated APIs and then update to this version without causing a
+        BC break.
+
+*   Feature / BC break: Consistently emit incoming "data" event with trailing newline
+    unless stream ends without trailing newline (such as when piping).
+    (#65 by @clue)
+
+*   Feature: Forward compatibility with upcoming Stream v1.0 and EventLoop v1.0
+    and avoid blocking when `STDOUT` buffer is full.
+    (#68 by @clue)
+
 ## 1.2.0 (2017-12-18)
 
 *   Feature: Optionally use `ext-readline` to enable raw input mode if available.

README.md

@@ -3,6 +3,13 @@
 Async, event-driven and UTF-8 aware console input & output (STDIN, STDOUT),
 built on top of for [ReactPHP](https://reactphp.org).
 
+You can use this library to build truly interactive and responsive command
+line (CLI) applications, that immediately react when the user types in
+a line. Inspired by `readline`, but supports UTF-8 and interleaved I/O
+(typing while output is being printed), history and autocomplete support
+and takes care of proper TTY settings under the hood without requiring
+any extensions or special installation.
+
 **Table of contents**
 
 * [Quickstart example](#quickstart-example)
@@ -407,8 +414,8 @@ $readline->setAutocomplete(function () {
 });
 ```
 
-If the user types `he [TAB]`, the first match will be skipped as it does not
-match the current word prefix and the second one will be picked automatically,
+If the user types `he [TAB]`, the first two matches will be skipped as they do
+not match the current word prefix and the last one will be picked automatically,
 so that the resulting input buffer is `hello `.
 
 If the user types `e [TAB]`, then this will match multiple entries and the user
@@ -427,7 +434,7 @@ This means that if the user types `hello [SPACE] ex [TAB]`, then the resulting
 input buffer is `hello exit `, which may or may not be what you need depending
 on your particular use case.
 
-In order to give your more control over this behavior, the autocomplete function
+In order to give you more control over this behavior, the autocomplete function
 actually receives three arguments (similar to `ext-readline`'s
 [`readline_completion_function()`](http://php.net/manual/en/function.readline-completion-function.php)):
 The first argument will be the current incomplete word according to current
@@ -518,7 +525,7 @@ This project follows [SemVer](http://semver.org/).
 This will install the latest supported version:
 
 ```bash
-$ composer require clue/stdio-react:^1.2
+$ composer require clue/stdio-react:^2.0
 ```
 
 See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "clue/stdio-react",
     "description": "Async, event-driven console input & output (STDIN, STDOUT), built on top of ReactPHP",
-    "keywords": ["stdio", "stdin", "stdout", "readline", "autocomplete", "autocompletion", "history", "ReactPHP", "async"],
+    "keywords": ["stdio", "stdin", "stdout", "interactive", "CLI", "readline", "autocomplete", "autocompletion", "history", "ReactPHP", "async"],
     "homepage": "https://github.com/clue/php-stdio-react",
     "license": "MIT",
     "authors": [