Skip to content

Commit 58531ac

Browse files
authored
Merge pull request #3 : Update readme
2 parents fe5422c + 4d5482e commit 58531ac

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,22 @@
33
A lightweight implementation of [CommonJS Promises/A][CommonJS Promises/A] for PHP.
44

55
> [!NOTE]
6-
> This is a fork of [reactphp/promise][reactphp/promise] with the following improvements:
7-
> - PHP 8.1+
8-
> - `declare(strict_types=1);` in all the PHP files
6+
> This is a fork of [reactphp/promise][reactphp/promise].
7+
>
8+
> Improvements over original reactphp/promise:
9+
>
10+
> - PHP 8.1+ compatibility
11+
> - `declare(strict_types=1);` in all PHP files
912
> - `@yield` annotation in the PromiseInterface
10-
> - Replaces `react/promise` v3
11-
> - Make rejection handler reusable. `error_log()` is still used by default.
13+
>
14+
> Version 3.x specific:
15+
> - Replaces `react/promise` v3 in Composer
16+
> - Rejection handler is reusable now. `error_log()` is still used by default.
1217
> - Removed `exit(255)` from RejectionPromise.
18+
>
19+
> Version 2.x specific:
20+
> - Replaces `react/promise` v2 in Composer
21+
> - Enhanced type annotations
1322
1423
## Install
1524

@@ -55,3 +64,5 @@ Also, large parts of the [documentation][documentation] have been ported from th
5564
[when.js]: https://github.com/cujojs/when
5665
[Brian Cavalier]: https://github.com/briancavalier
5766
[reactphp/promise]: https://github.com/reactphp/promise
67+
[Wiki]: https://github.com/cujojs/when/wiki
68+
[API docs]: https://github.com/cujojs/when/blob/master/docs/api.md

0 commit comments

Comments
 (0)