tikv
/
client-go
mirror of https://github.com/tikv/client-go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update readme (#143) 

Signed-off-by: disksing <i@disksing.com>
This commit is contained in:
disksing 2021-06-22 22:52:04 +08:00 committed by GitHub
parent 911d2b5294
commit 92afcfbf18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -4,7 +4,10 @@ TiKV Go Client provides support for interacting with the [TiKV](https://github.c
![Stability Active](https://img.shields.io/badge/Stability-Active-yellow) ![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) [![Go Reference](https://pkg.go.dev/badge/github.com/tikv/client-go/v2.svg)](https://pkg.go.dev/github.com/tikv/client-go/v2)
![Test Status](https://github.com/tikv/client-go/actions/workflows/test.yml/badge.svg?branch=v2)
[![Unit Test](https://github.com/tikv/client-go/actions/workflows/test.yml/badge.svg)](https://github.com/tikv/client-go/actions/workflows/test.yml)
[![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 ## Package versions
@ -21,6 +24,8 @@ There are 2 major versions of the `client-go` package.
go get github.com/tikv/client-go/v2@COMMIT_HASH_OR_TAG_VERSION 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/v2/examples).
## Contributing to client-go ## Contributing to client-go
Pull Requests and issues are welcomed. Please check [CONTRIBUTING.md](./CONTRIBUTING.md). Pull Requests and issues are welcomed. Please check [CONTRIBUTING.md](./CONTRIBUTING.md).
@ -79,10 +84,11 @@ go mod download github.com/tikv/client-go/v2
## Used By ## Used By
This project is used by the following projects: `client-go` is used by the following projects:
- TiDB: TiDB is an open source distributed HTAP database compatible with the MySQL protocol (https://github.com/pingcap/tidb) - TiDB: TiDB is an open source distributed HTAP database compatible with the MySQL protocol (https://github.com/pingcap/tidb)
- BR: A command-line tool for distributed backup and restoration of the TiDB cluster data (https://github.com/pingcap/br) - BR: A command-line tool for distributed backup and restoration of the TiDB cluster data (https://github.com/pingcap/br)
- TiCDC: Change data capture for TiDB (https://github.com/pingcap/ticdc)
## License ## License