From 86fe3ca4a59a2aff148f3aa9f201c8cbf832cbdf Mon Sep 17 00:00:00 2001
From: Cees-Jan Kiewiet <ceesjank@gmail.com>
Date: Fri, 9 Feb 2024 23:58:16 +0100
Subject: [PATCH] Hello `3.x` development branch

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: #312
Plans for ReactPHP v3: https://github.com/orgs/reactphp/discussions/481
PR templated from: https://github.com/friends-of-reactphp/mysql/pull/185
---
 README.md | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 18e3d91..8915e9d 100644
--- a/README.md
+++ b/README.md
@@ -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/socket/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.
@@ -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.