add readme (#80)

This commit is contained in:
disksing 2021-06-15 16:21:43 +08:00 committed by GitHub
parent 1cb7de4762
commit a34c866361
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 0 deletions

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# TiKV Go Client
TiKV Go Client provides support for interacting with the TiKV server in the form of a Go library.
## Usage/Examples
TODO
## Running Tests
To run tests, run the following command
```bash
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:
- TiDB (https://github.com/pingcap/tidb)
## License
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)