Skip to content

Commit

Permalink
Hello 3.x development branch
Browse files Browse the repository at this point in the history
Once this PR is merged, we can start working on the new [v3.0.0
milestone](https://github.com/reactphp/socket/milestone/43). The default
 branch will be `3.x` and the old `1.x` branch still stay in place at least until `3.0.0` is released.

Refs:
Road map ticket for socket: reactphp#312
Plans for ReactPHP v3: https://github.com/orgs/reactphp/discussions/481
PR templated from: friends-of-reactphp/mysql#185
  • Loading branch information
WyriHaximus committed Feb 9, 2024
1 parent 216d3ae commit d0e3242
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@
Async, streaming plaintext TCP/IP and secure TLS socket server and client
connections for [ReactPHP](https://reactphp.org/).

> **Development version:** This branch contains the code for the upcoming v3
> release. For the code of the current stable v1 release, check out the
> [`1.x` branch](https://github.com/reactphp/stream/tree/1.x).
>
> The upcoming v3 release will be the way forward for this package. However,
> we will still actively support v1 for those not yet on the latest version.
> See also [installation instructions](#install) for more details.
The socket library provides re-usable interfaces for a socket-layer
server and client based on the [`EventLoop`](https://github.com/reactphp/event-loop)
and [`Stream`](https://github.com/reactphp/stream) components.
Expand Down Expand Up @@ -1490,11 +1498,11 @@ $promise = $connector->connect('localhost:80');
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:
Once released, this project will follow [SemVer](https://semver.org/).
At the moment, this will install the latest development version:

```bash
composer require react/socket:^1.15
composer require react/socket:^3@dev
```

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

0 comments on commit d0e3242

Please sign in to comment.