From df187fa79aa1dedc293a1eae37ef8b3a522dba46 Mon Sep 17 00:00:00 2001 From: disksing Date: Thu, 24 Feb 2022 16:50:07 +0800 Subject: [PATCH] *: update readme (#430) Signed-off-by: disksing --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fc0b7c3b..5386f233 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,22 @@ TiKV Go Client provides support for interacting with the [TiKV](https://github.c [![Integration Test](https://github.com/tikv/client-go/actions/workflows/integration.yml/badge.svg)](https://github.com/tikv/client-go/actions/workflows/integration.yml) [![Compatibility Test](https://github.com/tikv/client-go/actions/workflows/compatibility.yml/badge.svg)](https://github.com/tikv/client-go/actions/workflows/compatibility.yml) - ## Package versions There are 2 major versions of the `client-go` package. -- `v2` is the new active version. This version was extracted from [pingcap/tidb](https://github.com/pingcap/tidb) and it includes new TiKV features like Follower Read, 1PC, Async Commit. The development of this version is on the `master` branch. The documentation for this version is below. +- `v2` is the latest stable version. This version was extracted from [pingcap/tidb](https://github.com/pingcap/tidb) and it includes new TiKV features like Follower Read, 1PC, Async Commit. The development of this version is on the `master` branch. The documentation for this version is below. - `v1` is the previous stable version and is only maintained for bug fixes. You can read the documentation [here](https://tikv.org/docs/4.0/reference/clients/go/). -```diff -- warning: The v2 branch is still being refactored and sorted out, and external interfaces may change before the v2.0.0 release. Please use caution in production environments. -``` - ## Usage/Examples ```bash + # valid versions be like @latest, @e5f932ae270887550b0cd221343dbd6b870b6c8f, @v2.0.0, @v2.0.1... go get github.com/tikv/client-go/v2@COMMIT_HASH_OR_TAG_VERSION ``` -More examples can be found in [examples directory](https://github.com/tikv/client-go/tree/master/examples). +Explanation of related concepts and sample code can be found in the [Client-Go Wiki](https://github.com/tikv/client-go/wiki). There are also executable examples in [examples directory](https://github.com/tikv/client-go/tree/master/examples). ## Contributing to client-go