[shardingsphere-on-cloud] 23/39: doc: update README

[du...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

duanzhengqiang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shardingsphere-on-cloud.git

commit 3c66e51efba3684801ea052d55be10bbe0de7526
Author: mlycore <ma...@126.com>
AuthorDate: Wed Jul 20 20:36:12 2022 +0800

    doc: update README
    
    Signed-off-by: mlycore <ma...@126.com>
---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 45 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 5caf46a..a70b350 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,49 @@
 # shardingsphere-on-cloud
-Contains various cloud solutions about ShardingSphere
+
+[![Build Status](https://github.com/SphereEx/shardingsphere-on-cloud/workflows/ci/badge.svg)](https://github.com/SphereEx/shardingsphere-on-cloud/actions)
+[![GitHub release](https://img.shields.io/github/release/SphereEx/shardingsphere-on-cloud.svg)](https://github.com/SphereEx/shardingsphere-on-cloud/releases)
+[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/ShardingSphere.svg?style=social&label=Follow%20%40ShardingSphere)](https://twitter.com/ShardingSphere)
+[![Slack](https://img.shields.io/badge/%20Slack-ShardingSphere%20Channel-blueviolet)](https://join.slack.com/t/apacheshardingsphere/shared_invite/zt-sbdde7ie-SjDqo9~I4rYcR18bq0SYTg)
+[![Gitter](https://badges.gitter.im/shardingsphere/shardingsphere.svg)](https://gitter.im/shardingsphere/Lobby)
+
+This repository collects scripts, tools, manifests and documentations, provides home for [Apache ShardingSphere](https://shardingsphere.apache.org/) on cloud solutions.
+
+Solutions currently included in this project:
+
+* The [ShardingSphere-Operator](https://github.com/SphereEx/shardingsphere-on-cloud/tree/main/shardingsphere-operator)
+
+The ShardingSphere operator uses predefined CustomResourceDefinitions for describing a Deployment for Apache ShardingSphere on Kubernetes. // ADD 
+
+
 ## ShardingSphere Operator
-Use the operator to create a ShardingSphere-Proxy cluster including the ZooKeeper cluster in the Kubernetes .
+### Prerequisites
+
+With the help of ShardingSphere-Operator you could create a ShardingSphere-Proxy cluster including the ZooKeeper cluster in minutes.
+
+For installation of SharingSphere-Operator, you will need a Kubernetes cluster, no matter it is a managed Kubernetes service like AWS EKS or self-hosted Kubernetes, or just a mini-kube, you can easily install ShardingSphere-Operator with respective [ShardingSphere Operator Helm Charts](https://github.com/SphereEx/shardingsphere-on-cloud/tree/main/charts/shardingsphere-cluster), and apply the manifests in [ShardingSphere Cluster Helm Charts](https://github.com/SphereEx/shardingsphere-on-c [...]
+
 ### Internal Architecture
+
 ![img.png](./doc/images/ss-operatorIA.png)
-### Status
-minimum viable product
-### how to install
+
+### Current Status
+
+Minimum Viable Product
+
+### Quick Start 
 
 [quick start](./doc/deploy.md)
-## Features
+
+### Features
+
 * Supports the use of proxy to configure and describe the shardingsphere-proxy cluster. For detailed configuration, see the deployment documentation
 * Support native shardingsphere proxy server.yaml configuration. For specific support items, please refer to the documentation
 * Support automatic creation of HPA based on cpu metrics
 * Support automatic download of MySQL driver
 
-## Deploy
-### Helm
+### Installation
+#### Helm
 * ShardingSphere-Operator chart
     * Support deploy shardingsphere operator
 * ShardingSphere-Cluster chart
@@ -24,9 +51,8 @@ minimum viable product
     * Support deploy Zookeeper by bitnami
     * Support automatic configuration of the address of the governance center
     * Use github pages  to host repositories and support helm repo add to add repositories 
-## Prerequisites
-- Kubernetes 1.18+
-## Deploy Prerequisites
+
+### Development Prerequisites
 
 To build ShardingSphere Operator from scratch you will need to install the following tools:
 
@@ -35,16 +61,17 @@ To build ShardingSphere Operator from scratch you will need to install the follo
 * make
 * Kubernetes 1.20+ 
 * Kubebuilder 3.4.1+
+
 ## Contributing
-We welcome all kinds of contributions from the open-source community, individuals and partners.
-[Contributing](./CONTRIBUTING.md)
-## Community
 
-[Slack channel](https://join.slack.com/t/apacheshardingsphere/shared_invite/zt-sbdde7ie-SjDqo9~I4rYcR18bq0SYTg). Best for: instant communications and online meetings, sharing your applications.
+To contribute to this project, refer to [Contributing](CONTRIBUTING.md).
 
-![wechat](./doc/images/ssvx.png)
-## License
-[Apache License 2.0](https://github.com/SphereEx/shardingsphere-on-cloud/blob/master/LICENSE)
+## Join the discussion
 
+If you have any questions or feedback regarding this project, join the [Apache ShardingSphere Slack](https://join.slack.com/t/apacheshardingsphere/shared_invite/zt-sbdde7ie-SjDqo9~I4rYcR18bq0SYTg).
 
+For Wechat users, follow this ![wechat offcial account](./doc/images/ssvx.png).
+
+## License
 
+Apache License 2.0, see [LICENSE](https://github.com/SphereEx/shardingsphere-on-cloud/blob/main/LICENSE).
\ No newline at end of file