Skip to content
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

Rename main branch to 4.x and update installation instructions #29

Merged
merged 1 commit into from
Feb 13, 2022
Merged

Rename main branch to 4.x and update installation instructions #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ to have an actual event loop and non-blocking libraries interacting with that
event loop for it to work. As long as you have a Promise-based API that runs in
an event loop, it can be used with this library.

> **Development version:** This branch contains the code for the upcoming 4.0
> release which will be the way forward for this package. However, we will still
> actively support 3.0 and 2.0 for those not yet on PHP 8.1+.
>
> If you're using an older PHP version, you may use the
> [`3.x` branch](https://github.com/reactphp/async/tree/3.x) (PHP 7.1+) or
> [`2.x` branch](https://github.com/reactphp/async/tree/2.x) (PHP 5.3+) which both
> provide a compatible API but do not take advantage of newer language features.
> See also [installation instructions](#install) for more details.

**Table of Contents**

* [Usage](#usage)
Expand Down Expand Up @@ -487,7 +497,7 @@ Once released, this project will follow [SemVer](https://semver.org/).
At the moment, this will install the latest development version:

```bash
$ composer require react/async:dev-main
$ composer require react/async:^4@dev
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
Expand All @@ -502,7 +512,11 @@ smooth upgrade path. If you're using an older PHP version, you may use the
[`2.x` branch](https://github.com/reactphp/async/tree/2.x) (PHP 5.3+) which both
provide a compatible API but do not take advantage of newer language features.
You may target multiple versions at the same time to support a wider range of
PHP versions.
PHP versions like this:

```bash
$ composer require "react/async:^4@dev || ^3@dev || ^2@dev"
```

## Tests

Expand Down