This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
The following commit(s) were added to refs/heads/master by this push:
new b28ff3f Docs: polish README.md
new 35e5698 Merge pull request #3 from aaron-ai/pr
b28ff3f is described below
commit b28ff3f3df535459f1717d8be0b0be25de506523
Author: Aaron Ai <[email protected]>
AuthorDate: Sat Jun 18 03:57:16 2022 +0800
Docs: polish README.md
---
README.md | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5f2eb01..8cf95aa 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
-# RocketMQ Clients - Collection of Polyglot Clients for Apache RocketMQ
\ No newline at end of file
+# RocketMQ Clients - Collection of Polyglot Clients for Apache RocketMQ
+
+## Overview
+
+Polyglot solution of clients for [Apache
RocketMQ](https://rocketmq.apache.org/), and both of them follow the
specification of [rocketmq-apis](https://github.com/apache/rocketmq-apis),
replace the previous protocol based on `RemotingCommand` by gRPC. Apart from
that, APIs from different language share the same model and semantics.
+
+## Goal
+
+Provides cloud-native and robust solution for mainstream programming languages.
+
+## Related
+
+* [rocketmq](https://github.com/apache/rocketmq): The implementation of
service-side.
+* [rocketmq-apis](https://github.com/apache/rocketmq-apis): Common
communication protocol of clients.
+* [RIP-37: New and Unified APIs](https://shimo.im/docs/m5kv92OeRRU8olqX):
RocketMQ proposal of new and unified APIs acrossing different language.
+* [RIP-39: Support gRPC protocol](https://shimo.im/docs/gXqmeEPYgdUw5bqo):
RocketMQ proposal of gRPC protocol support.
+
+## License
+
+[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
Copyright (C) Apache Software Foundation
