From a4e312e64a507d660a3d1ef66bbc62a851ae1909 Mon Sep 17 00:00:00 2001 From: Cees-Jan Kiewiet Date: Thu, 8 Feb 2024 07:40:54 +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/dns/milestone/33). 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 DNS: #219 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 3b3cf022..2df8d224 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,14 @@ Async DNS resolver 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/dns/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 main point of the DNS component is to provide async DNS resolution. However, it is really a toolkit for working with DNS messages, and could easily be used to create a DNS server. @@ -406,11 +414,11 @@ $executor->query( 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/dns:^1.12 +composer require react/dns:^3@dev ``` See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.