Skip to content

Commit 227e148

Browse files
committed
Prepare v2.0.0 release
1 parent aeb0258 commit 227e148

File tree

2 files changed

+43
-7
lines changed

2 files changed

+43
-7
lines changed

CHANGELOG.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,42 @@
1-
CHANGELOG
2-
=========
1+
# Changelog
32

4-
* 1.0.0 (2013-02-07)
3+
## 2.0.0 (2022-07-11)
54

6-
* First tagged release
5+
A major new feature release, see [**release announcement**](https://clue.engineering/2022/announcing-reactphp-async).
6+
7+
* We'd like to emphasize that this component is production ready and battle-tested.
8+
We plan to support all long-term support (LTS) releases for at least 24 months,
9+
so you have a rock-solid foundation to build on top of.
10+
11+
* The v4 release will be the way forward for this package. However, we will still
12+
actively support v3 and v2 to provide a smooth upgrade path for those not yet
13+
on PHP 8.1+. If you're using an older PHP version, you may use either version
14+
which all provide a compatible API but may not take advantage of newer language
15+
features. You may target multiple versions at the same time to support a wider range of
16+
PHP versions:
17+
18+
* [`4.x` branch](https://github.com/reactphp/async/tree/4.x) (PHP 8.1+)
19+
* [`3.x` branch](https://github.com/reactphp/async/tree/3.x) (PHP 7.1+)
20+
* [`2.x` branch](https://github.com/reactphp/async/tree/2.x) (PHP 5.3+)
21+
22+
This update involves some major changes over the previous `v1.0.0` release that
23+
has been deprecated since 2013. Accordingly, most consumers of this package
24+
should not be affected by any BC breaks. See below for more details:
25+
26+
* Feature / BC break: Change to Promise-based APIs instead of callbacks (continuation-passing style).
27+
Support promise cancellation and upcoming Promise v3.
28+
(#6, #7, #9 and #46 by @clue)
29+
30+
* Feature: Add new `await()` function (import from clue/reactphp-block).
31+
(#8 by @clue and #39 by @SimonFrings)
32+
33+
* Minor documentation improvements.
34+
(#38 by @SimonFrings and #53 by @nhedger)
35+
36+
* Improve test suite and add `.gitattributes` to exclude dev files from exports.
37+
Run tests on PHP 8.1, PHPUnit 9, switch to GitHub actions and clean up test suite.
38+
(#2, #3, #4, #5 and #10 by @clue)
39+
40+
## 1.0.0 (2013-02-07)
41+
42+
* First tagged release

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,11 +213,11 @@ React\Async\waterfall([
213213
The recommended way to install this library is [through Composer](https://getcomposer.org/).
214214
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
215215

216-
Once released, this project will follow [SemVer](https://semver.org/).
217-
At the moment, this will install the latest development version:
216+
This project follows [SemVer](https://semver.org/).
217+
This will install the latest supported version from this branch:
218218

219219
```bash
220-
composer require react/async:dev-main
220+
composer require react/async:^2
221221
```
222222

223223
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.

0 commit comments

Comments
 (0)