Skip to content

Commit 718b057

Browse files
committed
Prepare v1.5.0 release
1 parent 7618d1b commit 718b057

File tree

2 files changed

+49
-5
lines changed

2 files changed

+49
-5
lines changed

CHANGELOG.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,49 @@
11
# Changelog
22

3+
## 1.5.0 (2021-10-20)
4+
5+
* Feature: Simplify usage by supporting new [default loop](https://github.com/reactphp/event-loop#loop).
6+
(#60 by @clue)
7+
8+
```php
9+
// old (still supported)
10+
Clue\React\Block\await($promise, $loop);
11+
Clue\React\Block\awaitAny($promises, $loop);
12+
Clue\React\Block\awaitAll($promises, $loop);
13+
14+
// new (using default loop)
15+
Clue\React\Block\await($promise);
16+
Clue\React\Block\awaitAny($promises);
17+
Clue\React\Block\awaitAll($promises);
18+
```
19+
20+
* Feature: Added support for upcoming react/promise v3.
21+
(#61 by @davidcole1340 and @SimonFrings)
22+
23+
* Improve error reporting by appending previous message for `Throwable`s.
24+
(#57 by @clue)
25+
26+
* Deprecate `$timeout` argument for `await*()` functions.
27+
(#59 by @clue)
28+
29+
```php
30+
// deprecated
31+
Clue\React\Block\await($promise, $loop, $timeout);
32+
Clue\React\Block\awaitAny($promises, $loop, $timeout);
33+
Clue\React\Block\awaitAll($promises, $loop, $timeout);
34+
35+
// still supported
36+
Clue\React\Block\await($promise, $loop);
37+
Clue\React\Block\awaitAny($promises, $loop);
38+
Clue\React\Block\awaitAll($promises, $loop);
39+
```
40+
41+
* Improve API documentation.
42+
(#58 and #63 by @clue and #55 by @PaulRotmann)
43+
44+
* Improve test suite and use GitHub actions for continuous integration (CI).
45+
(#54 by @SimonFrings)
46+
347
## 1.4.0 (2020-08-21)
448

549
* Improve API documentation, update README and add examples.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -295,27 +295,27 @@ For long-running applications, using promise-based APIs by leveraging chained
295295

296296
## Install
297297

298-
The recommended way to install this library is [through Composer](https://getcomposer.org).
298+
The recommended way to install this library is [through Composer](https://getcomposer.org/).
299299
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
300300

301301
This project follows [SemVer](https://semver.org/).
302302
This will install the latest supported version:
303303

304304
```bash
305-
$ composer require clue/block-react:^1.4
305+
$ composer require clue/block-react:^1.5
306306
```
307307

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

310310
This project aims to run on any platform and thus does not require any PHP
311311
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
312312
HHVM.
313-
It's *highly recommended to use PHP 7+* for this project.
313+
It's *highly recommended to use the latest supported PHP version* for this project.
314314

315315
## Tests
316316

317317
To run the test suite, you first need to clone this repo and then install all
318-
dependencies [through Composer](https://getcomposer.org):
318+
dependencies [through Composer](https://getcomposer.org/):
319319

320320
```bash
321321
$ composer install
@@ -324,7 +324,7 @@ $ composer install
324324
To run the test suite, go to the project root and run:
325325

326326
```bash
327-
$ php vendor/bin/phpunit
327+
$ vendor/bin/phpunit
328328
```
329329

330330
## License

0 commit comments

Comments
 (0)