From 92afcfbf18a35cee115929eeead978064d1023ab Mon Sep 17 00:00:00 2001 From: disksing Date: Tue, 22 Jun 2021 22:52:04 +0800 Subject: [PATCH] update readme (#143) Signed-off-by: disksing --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 54b7a102..8260f9be 100644 --- a/README.md +++ b/README.md @@ -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) [![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 @@ -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 ``` +More examples can be found in [examples directory](https://github.com/tikv/client-go/tree/v2/examples). + ## Contributing to client-go 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 -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) - 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