From 3900e776b1741301775f3469b0ecaf73e5ba4a04 Mon Sep 17 00:00:00 2001 From: mxsm Date: Sat, 28 Sep 2024 18:06:53 +0800 Subject: [PATCH] =?UTF-8?q?[ISSUE=20#1016]=F0=9F=93=9DUpdate=20README.md?= =?UTF-8?q?=20(#1017)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 64 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ef8cbff2..abc3a270 100644 --- a/README.md +++ b/README.md @@ -61,15 +61,75 @@ Run the following command to start the name server cargo run --bin rocketmq-namesrv-rust ``` +### Run Borker + +**Run the following command to see usageļ¼š** + +- **windows platform** + + ```shell + cargo run --bin rocketmq-broker-rust -- --help + + RocketMQ Broker Server(Rust) + + Usage: rocketmq-broker-rust.exe [OPTIONS] + + Options: + -c, --config-file Broker config properties file + -m, --print-important-config Print important config item + -n, --namesrv-addr Name server address list, eg: '192.168.0.1:9876;192.168.0.2:9876' [default: 127.0.0.1:9876] + -p, --print-config-item Print all config item + -h, --help Print help + -V, --version Print version + ``` + + + +- **Linux platform** + + ```shell + $ cargo run --bin rocketmq-broker-rust -- --help + + RocketMQ Broker Server(Rust) + + Usage: rocketmq-broker-rust [OPTIONS] + + Options: + -c, --config-file Broker config properties file + -m, --print-important-config Print important config item + -n, --namesrv-addr Name server address list, eg: '192.168.0.1:9876;192.168.0.2:9876' [default: 127.0.0.1:9876] + -p, --print-config-item Print all config item + -h, --help Print help + -V, --version Print version + ``` + +Run the following command to start the name server + +```shell +cargo run --bin rocketmq-broker-rust +``` + +## Client how to send message + +First, start the RocketMQ NameServer and Broker services. + +- [**Send a single message**](https://github.com/mxsm/rocketmq-rust/blob/main/rocketmq-client/README.md#Send-a-single-message) + +- [**Send batch messages**](https://github.com/mxsm/rocketmq-rust/blob/main/rocketmq-client/README.md#Send-batch-messages) + +- [**Send RPC messages**](https://github.com/mxsm/rocketmq-rust/blob/main/rocketmq-client/README.md#Send-RPC-messages) + +[**For more examples, you can check here**](https://github.com/mxsm/rocketmq-rust/tree/main/rocketmq-client/examples) + ## Modules The existing RocketMQ has the following functional modules: -- [**Name Server**](./rockemt-namesrv) -- [**Broker**](./rocketmq-broker) -- [**Store (Local Storage)**](./rocketmq-store) +- [**Name Server**](https://github.com/mxsm/rocketmq-rust/tree/main/rocketmq-namesrv) +- [**Broker**](https://github.com/mxsm/rocketmq-rust/tree/main/rocketmq-broker) +- [**Store (Local Storage)**](https://github.com/mxsm/rocketmq-rust/tree/main/rocketmq-store) - **Controller (High Availability)** -- [**Client (SDK)**](./rocketmq-client) +- [**Client (SDK)**](https://github.com/mxsm/rocketmq-rust/tree/main/rocketmq-client) - **Proxy** - **Tiered Store (Tiered Storage Module)**