From c424af9b32f6158af19e312d33fe0d1e2bebaaf5 Mon Sep 17 00:00:00 2001
From: Rory Z <16801068+Rory-Z@users.noreply.github.com>
Date: Sat, 7 Oct 2023 14:12:06 +0800
Subject: [PATCH] docs: update README
Signed-off-by: Rory Z <16801068+Rory-Z@users.noreply.github.com>
---
README.md | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 788a342fd..e72dbf469 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,16 @@
-# EMQX Operator
+
+ EMQX Operator
+
+
+Visit emqx.io for the full documentation, examples and guides.
+
+
[![GitHub Release](https://img.shields.io/github/release/emqx/emqx-operator?color=brightgreen)](https://github.com/emqx/emqx-operator/releases)
[![Docker Pulls](https://img.shields.io/docker/pulls/emqx/emqx-operator-controller)](https://hub.docker.com/r/emqx/emqx-operator-controller)
[![codecov](https://codecov.io/gh/emqx/emqx-operator/branch/main/graph/badge.svg?token=RNMH7K52JZ)](https://codecov.io/gh/emqx/emqx-operator)
-A Kubernetes Operator for [EMQX](https://www.emqx.io)
+
## Overview
@@ -12,7 +18,6 @@ The EMQX Operator provides [Kubernetes](https://kubernetes.io/) native deploymen
The EMQX Operator includes, but is not limited to, the following features:
-
* **Simplified Deployment EMQX**: Declare EMQX clusters with EMQX custom resources and deploy them quickly. For more details, please check [Getting Started](./docs/en_US/getting-started/getting-started.md).
* **Manage EMQX Cluster**: Automate operations and maintenance for EMQX, including cluster upgrades, runtime data persistence, updating Kubernetes resources based on the status of EMQX, etc. For more details, please check [Manage EMQX](./docs/en_US/tasks/overview.md).