Skip to content

Commit

Permalink
Prepare v1.5.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Oct 20, 2021
1 parent 7618d1b commit 718b057
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 5 deletions.
44 changes: 44 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
# Changelog

## 1.5.0 (2021-10-20)

* Feature: Simplify usage by supporting new [default loop](https://github.com/reactphp/event-loop#loop).
(#60 by @clue)

```php
// old (still supported)
Clue\React\Block\await($promise, $loop);
Clue\React\Block\awaitAny($promises, $loop);
Clue\React\Block\awaitAll($promises, $loop);

// new (using default loop)
Clue\React\Block\await($promise);
Clue\React\Block\awaitAny($promises);
Clue\React\Block\awaitAll($promises);
```

* Feature: Added support for upcoming react/promise v3.
(#61 by @davidcole1340 and @SimonFrings)

* Improve error reporting by appending previous message for `Throwable`s.
(#57 by @clue)

* Deprecate `$timeout` argument for `await*()` functions.
(#59 by @clue)

```php
// deprecated
Clue\React\Block\await($promise, $loop, $timeout);
Clue\React\Block\awaitAny($promises, $loop, $timeout);
Clue\React\Block\awaitAll($promises, $loop, $timeout);

// still supported
Clue\React\Block\await($promise, $loop);
Clue\React\Block\awaitAny($promises, $loop);
Clue\React\Block\awaitAll($promises, $loop);
```

* Improve API documentation.
(#58 and #63 by @clue and #55 by @PaulRotmann)

* Improve test suite and use GitHub actions for continuous integration (CI).
(#54 by @SimonFrings)

## 1.4.0 (2020-08-21)

* Improve API documentation, update README and add examples.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,27 +295,27 @@ For long-running applications, using promise-based APIs by leveraging chained

## Install

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

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

```bash
$ composer require clue/block-react:^1.4
$ composer require clue/block-react:^1.5
```

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

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

## Tests

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

```bash
$ composer install
Expand All @@ -324,7 +324,7 @@ $ composer install
To run the test suite, go to the project root and run:

```bash
$ php vendor/bin/phpunit
$ vendor/bin/phpunit
```

## License
Expand Down

0 comments on commit 718b057

Please sign in to comment.