diff --git a/README.md b/README.md index 74a81008de990..e894003f08f84 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![](docs/logo_with_text.png) +TiDB, a distributed SQL database [![LICENSE](https://img.shields.io/github/license/pingcap/tidb.svg)](https://github.com/pingcap/tidb/blob/master/LICENSE) [![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/) @@ -12,15 +12,15 @@ ## What is TiDB? -TiDB ("Ti" stands for Titanium) is an open-source NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. +TiDB (/’taɪdiːbi:/, "Ti" stands for Titanium) is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. - [Key features](https://docs.pingcap.com/tidb/stable/overview#key-features) - [Architecture](#architecture) -- [MySQL Compatibility](https://docs.pingcap.com/tidb/stable/mysql-compatibility) +- [MySQL compatibility](https://docs.pingcap.com/tidb/stable/mysql-compatibility) -For more details and latest updates, see [TiDB docs](https://docs.pingcap.com/tidb/stable) and [release notes](https://docs.pingcap.com/tidb/dev/release-notes). +For more details and latest updates, see [TiDB documentation](https://docs.pingcap.com/tidb/stable) and [release notes](https://docs.pingcap.com/tidb/dev/release-notes). -For future plans, see [TiDB Roadmap](roadmap.md). +For future plans, see the [TiDB roadmap](roadmap.md). ## Quick start @@ -38,40 +38,42 @@ See [TiDB Quick Start Guide](https://docs.pingcap.com/tidb/stable/quick-start-wi ### Start developing TiDB -See [Get Started](https://pingcap.github.io/tidb-dev-guide/get-started/introduction.html) chapter of [TiDB Dev Guide](https://pingcap.github.io/tidb-dev-guide/index.html). +See the [Get Started](https://pingcap.github.io/tidb-dev-guide/get-started/introduction.html) chapter of [TiDB Development Guide](https://pingcap.github.io/tidb-dev-guide/index.html). ## Community -You can join these groups and chats to discuss and ask TiDB related questions: +You can join the following groups or channels to discuss or ask questions about TiDB, and to keep yourself informed of the latest TiDB updates: -- [TiDB Internals Forum](https://internals.tidb.io/) -- [Slack Channel](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap-tidb) -- [TiDB User Group Forum (Chinese)](https://asktug.com) - -In addition, you may enjoy following: - -- [@PingCAP](https://twitter.com/PingCAP) on Twitter -- Question tagged [#tidb on StackOverflow](https://stackoverflow.com/questions/tagged/tidb) -- The PingCAP Team [English Blog](https://en.pingcap.com/blog) and [Chinese Blog](https://pingcap.com/blog-cn/) +- Discuss TiDB's implementation and design + - [TiDB Internals forum](https://internals.tidb.io/) +- Seek help when you use TiDB + - Slack channels: [#everyone](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap-tidb) (English), [#tidb-japan](https://slack.tidb.io/invite?team=tidb-community&channel=tidb-japan&ref=github-tidb) (Japanese) + - [TiDB User Group forum](https://asktug.com) (Chinese) + - [Stack Overflow](https://stackoverflow.com/questions/tagged/tidb) (questions tagged with #tidb) +- Get the latest TiDB news or updates + - Follow [@PingCAP](https://twitter.com/PingCAP) on Twitter + - Read the PingCAP [English Blog](https://www.pingcap.com/blog/?from=en) or [Chinese Blog](https://cn.pingcap.com/blog/) For support, please contact [PingCAP](http://bit.ly/contact_us_via_github). ## Contributing -The [community repository](https://github.com/pingcap/community) hosts all information about the TiDB community, including how to contribute to TiDB, how TiDB community is governed, how special interest groups are organized, etc. +The [community repository](https://github.com/pingcap/community) hosts all information about the TiDB community, including [how to contribute](https://github.com/pingcap/community/blob/master/contributors/README.md) to TiDB, how the TiDB community is governed, how [teams](https://github.com/pingcap/community/blob/master/teams/README.md) are organized. + +Contributions are welcomed and greatly appreciated. You can get started with one of the [good first issues](https://github.com/pingcap/tidb/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or [help wanted issues](https://github.com/pingcap/tidb/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). For more details on typical contribution workflows, see [Contribute to TiDB](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/introduction.html). For more contributing information about where to start, click the contributor icon below. [contribution-map](https://github.com/pingcap/tidb-map/blob/master/maps/contribution-map.md#tidb-is-an-open-source-distributed-htap-database-compatible-with-the-mysql-protocol) -Contributions are welcomed and greatly appreciated. All the contributors are welcomed to claim your reward by filing this [form](https://forms.pingcap.com/f/tidb-contribution-swag). See [Contribution to TiDB](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/introduction.html) for details on typical contribution workflows. For more contributing information, click on the contributor icon above. +Every contributor is welcome to claim your contribution swag by filling in and submitting this [form](https://forms.pingcap.com/f/tidb-contribution-swag). ## Case studies -- [English](https://pingcap.com/case-studies) -- [简体中文](https://pingcap.com/cases-cn/) +- [Case studies in English](https://www.pingcap.com/customers/) +- [中文用户案例](https://cn.pingcap.com/case/) ## Architecture -![architecture](./docs/architecture.png) +![TiDB architecture](./docs/tidb-architecture.png) ## License diff --git a/docs/logo_with_text.png b/docs/logo_with_text.png deleted file mode 100644 index 722bbf8f8c53a..0000000000000 Binary files a/docs/logo_with_text.png and /dev/null differ diff --git a/docs/tidb-architecture.png b/docs/tidb-architecture.png new file mode 100644 index 0000000000000..e3360c45258dd Binary files /dev/null and b/docs/tidb-architecture.png differ diff --git a/docs/tidb-logo-with-text.png b/docs/tidb-logo-with-text.png new file mode 100644 index 0000000000000..111465b9fc842 Binary files /dev/null and b/docs/tidb-logo-with-text.png differ