From 8df0259da29cea351e9e735f5805cd38ef616058 Mon Sep 17 00:00:00 2001
From: shizhili <shizhili_yewu@cmss.chinamobile.com>
Date: Mon, 11 Dec 2023 17:24:25 +0800
Subject: [PATCH] add readme

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 47 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index bb44aeb..f7b8b03 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # rocketmq
 
 #### 介绍
-A Distributed Messaging Platform
+RocketMQ是一个分布式的消息和流处理平台，具有低延迟、高性能、高可靠性、百亿级容量和灵活扩缩容能力。
 
 #### 软件架构
 软件架构说明
@@ -9,15 +9,54 @@ A Distributed Messaging Platform
 
 #### 安装教程
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
+1.  切换yum源
+```shell
+cd /etc/yum.repos.d/ && curl -OL https://eur.openeuler.openatom.cn/coprs/zhiliatox/example/repo/openeuler-22.03_LTS_SP2/zhiliatox-example-openeuler-22.03_LTS_SP2.repo
+```
+2.  安装rocketmq
+```shell
+dnf install rocketmq
+```
+3. 使用RocketMQ
+```shell
+cd /opt/rocketmq
+```
+   
 #### 使用说明
+1. 启动Namesrv
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
+对于Mac或者Linux用户：
+```shell
+### 启动Namesrv
+$ nohup sh mqnamesrv &
+
+### 检查日志确定Namesrv是否启动成功
+$ tail -f ~/logs/rocketmqlogs/namesrv.log
+The Name Server boot success...
+```
+对于Windows用户：
+```shell
+$ nohup mqnamesrv.cmd &
+The Name Server boot success...
+```
+
+2. 启动Broker
+
+对于Mac或者Linux用户：
+```shell
+### start Broker
+$ nohup sh bin/mqbroker -n localhost:9876 &
+
+### check whether Broker is successfully started, eg: Broker's IP is 192.168.1.2, Broker's name is broker-a
+$ tail -f ~/logs/rocketmqlogs/broker.log
+The broker[broker-a, 192.169.1.2:10911] boot success...
+```
+
+对于Windows用户：
+```shell
+$ mqbroker.cmd -n localhost:9876
+The broker[broker-a, 192.169.1.2:10911] boot success...
+```
 
 #### 参与贡献