From bd6d961f75d69f3482fb77dea3f57751e1df1952 Mon Sep 17 00:00:00 2001 From: Caitin <34535727+CaitinChen@users.noreply.github.com> Date: Tue, 26 Jan 2021 18:39:43 +0800 Subject: [PATCH] README: add info and fix typos (#1095) * READM: add info and fix typos * Update README.md --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 045084dead..6b347ccecc 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,21 @@ # What is TiUP -`tiup` is a tool to download and install TiDB components. +`tiup` is a tool to download and install [TiDB](https://docs.pingcap.com/tidb/stable/overview) components. + +## Documentation + +- [English](https://docs.pingcap.com/tidb/stable/tiup-documentation-guide) +- [简体中文](https://docs.pingcap.com/zh/tidb/stable/tiup-documentation-guide) + +## Blog + +- [English](https://pingcap.com/blog/) +- [简体中文](https://pingcap.com/blog-cn/) + +## TiDB Monthly + +[TiDB Monthly](https://pingcap.com/weekly/) ## Installation @@ -40,20 +54,21 @@ tiup uninstall tidb tikv pd tiup update --all ``` -# Usage +## Usage + After installing `tiup`, you can use it to install binaries of TiDB components and create clusters. See our [doc](doc/user/README.md) for more information on how to use TiUp. -# Contributing to TiUp +## Contributing to TiUP -Contributions of code, tests, docs, and bug reports are welcome! To get started take a look at our [open issues](https://github.com/pingcap/tiup/issues). +Contributions of code, tests, docs, and bug reports are welcome! To get started, take a look at our [open issues](https://github.com/pingcap/tiup/issues). -For docs on how to build, test, and run TiUp, see our [dev docs](doc/dev/README.md). +For docs on how to build, test, and run TiUP, see our [dev docs](doc/dev/README.md). See also the [Contribution Guide](https://github.com/pingcap/community/blob/master/contributors/README.md) in PingCAP's [community](https://github.com/pingcap/community) repo. - ## License + [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpingcap%2Ftiup.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpingcap%2Ftiup?ref=badge_large)