From ea978621f48e650fa35d4f87a71eb3da759b2d38 Mon Sep 17 00:00:00 2001 From: disksing Date: Wed, 16 Jun 2021 18:01:19 +0800 Subject: [PATCH] update readme (#84) Signed-off-by: disksing --- .github/workflows/{go.yml => test.yml} | 4 ++-- README.md | 25 +++++++++++++++---------- 2 files changed, 17 insertions(+), 12 deletions(-) rename .github/workflows/{go.yml => test.yml} (86%) diff --git a/.github/workflows/go.yml b/.github/workflows/test.yml similarity index 86% rename from .github/workflows/go.yml rename to .github/workflows/test.yml index b7972f94..756c210c 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/test.yml @@ -18,8 +18,8 @@ jobs: with: go-version: 1.16 - - name: Build - run: go build -v ./... + - name: Tidy + run: go mod tidy - name: Test run: go test -v ./... diff --git a/README.md b/README.md index dd2c3656..7215dfa1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,23 @@ # TiKV Go Client -TiKV Go Client provides support for interacting with the TiKV server in the form of a Go library. +TiKV Go Client provides support for interacting with the [TiKV](https://github.com/tikv/tikv) server in the form of a Go library. + +![Stability Active](https://img.shields.io/badge/Stability-Active-yellow) +[![Go Reference](https://pkg.go.dev/badge/github.com/tikv/client-go/v2.svg)](https://pkg.go.dev/github.com/tikv/client-go/v2) + +## Package versions + +There are 2 major versions of the `client-go` package. + +- `v2` is the new stable and 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 `v2` 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/). ## Usage/Examples -TODO +```bash + go get github.com/tikv/client-go/v2@COMMIT_HASH_OR_TAG_VERSION +``` ## Running Tests @@ -14,14 +27,6 @@ To run tests, run the following command go test ./... ``` -## FAQ - -#### Difference between v1 and v2 version - -The v2 version is extracted from the TiDB project and will be kept up to date afterwards. - -v1 will be gradually abandoned for maintenance and is currently placed in the master branch for compatibility reasons. - ## Used By This project is used by the following projects: