[ISSUE #125]📝Add README.md for every crate

rocketmq-common/Cargo.toml

@@ -6,6 +6,7 @@ edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
 license.workspace = true
+readme = "README.md"
 description = "Rust implementation of Apache rocketmq common"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

rocketmq-common/README.md

@@ -0,0 +1,5 @@
+# The Rust Implementation of Apache RocketMQ Common
+
+## Overview
+
+Implementation of the Common module in RocketMQ Java version. It mainly houses common methods, aiming to maintain consistency with the RocketMQ Java version.

rocketmq-macros/Cargo.toml

@@ -7,7 +7,7 @@ homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 keywords.workspace = true
-readme.workspace = true
+readme = "README.md"
 description.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

rocketmq-macros/README.md

@@ -0,0 +1,5 @@
+# The Rust Implementation of Apache RocketMQ macros
+
+## Overview
+
+The entire set of common macros for RocketMQ-Rust is implemented in this module.

rocketmq-remoting/Cargo.toml

@@ -7,6 +7,7 @@ homepage.workspace = true
 repository.workspace = true
 license.workspace = true
 description = "Rust implementation of Apache rocketmq remoting"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

rocketmq-remoting/README.md

@@ -0,0 +1,5 @@
+# The Rust Implementation of Apache RocketMQ remoting
+
+## Overview
+
+The remoting module is primarily responsible for protocol encoding and decoding, as well as network-related functionalities.