From d7318a2fd7a8a85b52fb9c3d3a71dbe03a6befcc Mon Sep 17 00:00:00 2001 From: Joshua Humphries <2035234+jhump@users.noreply.github.com> Date: Fri, 13 Sep 2024 17:17:34 -0400 Subject: [PATCH] Fix badge and tweak README text about state of v2.0.0. (#623) --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9f3ed32b..13333165 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,21 @@ This repo builds on top of the reflection capabilities in the [Protobuf runtime for Go](https://pkg.go.dev/google.golang.org/protobuf/reflect/protoreflect) and also provides reflection APIs for [gRPC](https://grpc.io/) as well. -[![GoDoc](https://pkg.go.dev/github.com/jhump/protoreflect/v2?status.svg)](https://pkg.go.dev/github.com/jhump/protoreflect/v2) +[![GoDoc](https://pkg.go.dev/badge/github.com/jhump/protoreflect/v2.svg)](https://pkg.go.dev/github.com/jhump/protoreflect/v2) > [!NOTE] -> This v2 branch is a work in progress. It is basically feature complete, but still needs more tests for -> the new functionality and may also need some changes to the API to ensure long-term compatibility with -> interfaces in the Protobuf Go runtime. +> Version 2.0.0 is still a work in progress. It is basically feature complete, but still needs more tests +> for the new functionality. > > You can try it out by getting a pre-release version: > ``` > go get github.com/jhump/protoreflect/v2@v2.0.0-beta.1 > ``` > -> Note that the APIs are likely to change a little bit between now and a formal v2 release. Also note -> that some packages in the v2 still need more tests, so you may find some bugs, but that is mostly -> for new functionality. If you're just trying to update your code from v1 of this repo, those packages -> should be rock-solid and least likely to see any further API changes. +> Note that the APIs may change a little bit between now and a final v2.0.0 release. Also note +> that some packages in v2 still need more tests, so you may find some bugs. But that should mostly +> be for new functionality. If you're just trying to update your code from v1 of this repo, those +> packages should be rock-solid and least likely to see any further API changes. ---- ## Descriptors and Reflection Utilities