readme: update stabability description (#215)

Signed-off-by: disksing <i@disksing.com>
This commit is contained in:
disksing 2021-07-06 13:48:09 +08:00 committed by GitHub
parent 6ca00989dd
commit 5306eb4a63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions

View File

@ -14,10 +14,14 @@ TiKV Go Client provides support for interacting with the [TiKV](https://github.c
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 `master` branch. The documentation for this version is below.
- `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.
- `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