You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dubbo.apache.org by li...@apache.org on 2022/07/23 14:44:47 UTC
[dubbo-rust] 24/35: init readme
This is an automated email from the ASF dual-hosted git repository.
liujun pushed a commit to branch poc-idl
in repository https://gitbox.apache.org/repos/asf/dubbo-rust.git
commit 1182f56fa3912f23976176443ba6544d5c8c82b4
Author: Johankoi <Jo...@163.com>
AuthorDate: Thu Jul 14 12:01:03 2022 +0800
init readme
---
README_CN.md | 40 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
diff --git a/README_CN.md b/README_CN.md
index e69de29..82f4595 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -0,0 +1,40 @@
+bubbo-rust
+=========
+
+Rust implementation of [gRPC] protocol for [Dubbo], under development.
+
+
+[Examples] | [Docs]
+
+## Overview
+
+[`bubbo-rust`] is composed of three main components: the generic gRPC implementation, the gRPC codegen
+implementation with dubbo-build powered by [`prost`]. The transporter layer implementation can support any HTTP/2
+implementation is based on [`hyper`] [`tower`]. The message layer implementation can support any user defined bytes format.
+
+## Features
+- async/await service trait define
+- generate gRPC code for easy use
+- message byte define
+
+## Getting Started
+Examples can be found in [`examples`]
+
+
+### Tutorials
+
+- The [`protobuf-transport`][protobuf-transport] example provides a basic example for testing transport protobuf-message-object-data via HTTP/2.
+- The [`grpc-gen`][grpc-gen] example provides a complete example of using bubbo-rust client/server grpc.
+
+### Contribution
+[gRPC]: https://grpc.io
+[dubbo]: https://dubbo.apache.org/en/
+[`prost`]: https://github.com/tokio-rs/prost
+[`hyper`]: https://github.com/hyperium/hyper
+[`tower`]: https://github.com/tower-rs/tower
+[`examples`]: https://github.com/Johankoi/dubbo-rust/tree/main/examples
+[`protobuf-transport`]: https://github.com/Johankoi/dubbo-rust/tree/main/examples/protobuf-transport
+[`grpc-gen`]: https://github.com/Johankoi/dubbo-rust/tree/main/examples/grpc-gen
+
+
+