diff --git a/CHANGELOG.md b/CHANGELOG.md index 123bfcb..651429b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,42 @@ # Changelog +## 0.6.0 (2023-11-10) + +* Feature: Improve Promise v3 support and use template types. + (#183 and #178 by @clue) + +* Feature: Full PHP 8.3 compatibility. + (#180 by @clue) + +* Feature / BC break: Update default charset encoding to `utf8mb4` for full UTF-8 support. + (#165 by @clue) + + This feature updates the MySQL client to use `utf8mb4` as the default charset + encoding for full UTF-8 support instead of the legacy `utf8mb3` charset encoding. + For legacy reasons you can still change this to use a different ASCII-compatible + charset encoding like this: + + ```php + $factory->createConnection('localhost?charset=utf8mb4'); + ``` + +* Feature: Reduce default idle time to 1ms. + (#182 by @clue) + + The idle time defines the time the client is willing to keep the underlying + connection alive before automatically closing it. The default idle time was + previously 60s and can be configured for more specific requirements like this: + + ```php + $factory->createConnection('localhost?idle=10.0'); + ``` + +* Minor documentation improvements. + (#184 by @yadaiio) + +* Improve test suite, update to use reactphp/async and report failed assertions. + (#164 and #170 by @clue, #163 by @dinooo13 and #181 by @SimonFrings) + ## 0.5.7 (2022-09-15) * Feature: Full support for PHP 8.2. diff --git a/README.md b/README.md index 97cc083..c1f938a 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,6 @@ Async MySQL database client for [ReactPHP](https://reactphp.org/). -> **Development version:** This branch contains the code for the upcoming 0.6 release. -> For the code of the current stable 0.5 release, check out the -> [`0.5.x` branch](https://github.com/friends-of-reactphp/mysql/tree/0.5.x). -> -> The upcoming 0.6 release will be the way forward for this package. -> However, we will still actively support 0.5.x for those not yet -> on the latest version. -> See also [installation instructions](#install) for more details. - This is a MySQL database driver for [ReactPHP](https://reactphp.org/). It implements the MySQL protocol and allows you to access your existing MySQL database. @@ -511,11 +502,11 @@ See also the [`close()`](#close) method. The recommended way to install this library is [through Composer](https://getcomposer.org/). [New to Composer?](https://getcomposer.org/doc/00-intro.md) -Once released, this project will follow [SemVer](https://semver.org/). -At the moment, this will install the latest development version: +This project follows [SemVer](https://semver.org/). +This will install the latest supported version: ```bash -composer require react/mysql:^0.6@dev +composer require react/mysql:^0.6 ``` See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.