Prepare v2.3.0 release

clue · Aug 28, 2019 · 5f42a3a · 5f42a3a
1 parent 5ec6440
commit 5f42a3a
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,31 @@
 # Changelog
 
+## 2.3.0 (2019-08-28)
+
+*   Feature: Emit audible/visible BELL signal when using a disabled function.
+    (#86 and #87 by @clue)
+
+    By default, this project will emit an audible/visible BELL signal when the user
+    tries to execute an otherwise disabled function, such as using the
+    <kbd>left</kbd> or <kbd>backspace</kbd> keys when already at the beginning of the line.
+
+*   Deprecated: Deprecate `Readline` class and move all methods to `Stdio`.
+    (#84 by @clue)
+
+    ```php
+    // deprecated:
+    $stdio->getReadline()->setPrompt('> ');
+
+    // recommended alternative:
+    $stdio->setPrompt('> ');
+    ```
+
+*   Fix: Fix closing to emit final `close` event and clean up all listeners.
+    (#88 by @clue)
+
+*   Improve test suite to test against legacy PHP 5.3 through PHP 7.3 and support PHPUnit 7.
+    (#85 by @clue)
+
 ## 2.2.0 (2018-09-03)
 
 *   Feature / Fix: Accept CR as an alias for LF to support more platforms.

diff --git a/README.md b/README.md
@@ -432,7 +432,7 @@ on your particular use case.
 
 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)):
+[`readline_completion_function()`](https://www.php.net/manual/en/function.readline-completion-function.php)):
 The first argument will be the current incomplete word according to current
 cursor position and word boundaries, while the second and third argument will be
 the start and end offset of this word within the complete input buffer measured
@@ -537,7 +537,7 @@ $stdio->on("\033[A", function () use ($stdio) {
 
 #### Bell
 
-By default, this project will emit a audible/visible BELL signal when the user
+By default, this project will emit an audible/visible BELL signal when the user
 tries to execute an otherwise disabled function, such as using the
 <kbd>left</kbd> or <kbd>backspace</kbd> keys when already at the beginning of the line.
 
@@ -622,7 +622,7 @@ This project follows [SemVer](https://semver.org/).
 This will install the latest supported version:
 
 ```bash
-$ composer require clue/stdio-react:^2.2
+$ composer require clue/stdio-react:^2.3
 ```
 
 See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.