This is an automated email from the ASF dual-hosted git repository.
lizhanhui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-client-rust.git
The following commit(s) were added to refs/heads/master by this push:
new 6da11b1 Add README.md file
6da11b1 is described below
commit 6da11b116e0adb7c3d46b0854cbf8acf185442ac
Author: Li Zhanhui <[email protected]>
AuthorDate: Sun Feb 27 20:18:41 2022 +0800
Add README.md file
---
README.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f824bfd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+Introduction
+--------------
+Project rocketmq-client-rust is targeted to implement Rust binding in native
Rust code. At the current moment, it is still a work-in-progress project. Do
not use it in production till it grows mature enough.
+
+Architecture
+--------------
+Basically, this project would follow the same paradigm of [rocketmq-client-cpp
v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we
would build the whole client following protocols described in
[rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of
[tokio](https://tokio.rs/), utilizing [Protocol
buffers](https://developers.google.com/protocol-buffers) to serialize and
deserialize data in transmission.
+
+
+How to build
+-----------------
+We would use cargo to build, run and test.
+
+License
+------------------
+This project follows [Apache License Version 2.0](./LICENSE).
+
+How to contribute
+------------------
+Similar to other Apache RocketMQ projects, we welcome contributions in various
ways, from filing a bug report, correcting type error, document writing to
complete feature implementation. Any attempt to make this project better is
welcome.
+
+If this project catches your attention, do not hesitate to make a pull request.
\ No newline at end of file
