Skip to content

Update readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 28, 2025
Merged

Update readme #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5dbcde
docs: Fix links in README
roxblnfk Aug 28, 2025
4d5482e
docs(readme): Optimize version changelog by grouping common improvements
roxblnfk Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,22 @@
A lightweight implementation of [CommonJS Promises/A][CommonJS Promises/A] for PHP.

> [!NOTE]
> This is a fork of [reactphp/promise][reactphp/promise] with the following improvements:
> - PHP 8.1+
> - `declare(strict_types=1);` in all the PHP files
> This is a fork of [reactphp/promise][reactphp/promise].
>
> Improvements over original reactphp/promise:
>
> - PHP 8.1+ compatibility
> - `declare(strict_types=1);` in all PHP files
> - `@yield` annotation in the PromiseInterface
> - Replaces `react/promise` v3
> - Make rejection handler reusable. `error_log()` is still used by default.
>
> Version 3.x specific:
> - Replaces `react/promise` v3 in Composer
> - Rejection handler is reusable now. `error_log()` is still used by default.
> - Removed `exit(255)` from RejectionPromise.
>
> Version 2.x specific:
> - Replaces `react/promise` v2 in Composer
> - Enhanced type annotations

## Install

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