This is an automated email from the ASF dual-hosted git repository.
liujun pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/dubbo-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 6835314 rewrite README
new c13765f Merge pull request #36 from LJpgr/main
6835314 is described below
commit 683531424c95c64cee1ac14a9affb0ee019f0a9c
Author: LJpgr <[email protected]>
AuthorDate: Sat Aug 13 15:01:32 2022 +0800
rewrite README
---
README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
README_CN.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 152 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f39d9ab..31d1fd7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,77 @@
-# dubbo-rust
+# Apache Dubbo-rust
+
+<a href="https://dubbo.apache.org/";>
+ <img style="vertical-align: top;"
src="https://dubbo.apache.org/imgs/dubbo_colorful.png"; alt="logo"
height="45px"></a>
+
+Apache Dubbo-rust, an RPC framework that implements Dubbo written in
Rust.Please visit the [official website](https://dubbo.apache.org/) for more
information.
+
+[](https://travis-ci.org/apache/dubbo-rust)
+
+[ [中文](./README_CN.md) ]
+
+## Overview
+
+Dubbo-rust is still under development. For now, gRPC calls based on HTTP2 have
been implemented.
+
+The following libraries are mainly dependent on:
+
+- [`Tokio`](https://github.com/tokio-rs/tokio) is an event-driven,
non-blocking I/O platform for writing asynchronous applications with Rust.
+
+- [`Prost`](https://github.com/tokio-rs/prost/) is a [Protocol
Buffers](https://developers.google.com/protocol-buffers/) implementation for
Rust.
+
+-
[`Hyper`](https://github.com/hyperium/hyperhttps://github.com/hyperium/hyper)
is a fast and correct HTTP implementation for Rust.
+
+- [`Serde`](https://github.com/serde-rs/serde) is a framework for
*ser*ializing and *de*serializing Rust data structures efficiently and
generically.
+
+## Features
+
+- :white_check_mark: RPC synchronous / asynchronous call
+- :white_check_mark: IDL code automatic generation
+- :construction: Multiple RPC protocol support (like Triple, Dubbo, gRPC,
JSONRPC)
+- :construction: Support TCP/HTTP2 transport protocol
+- :construction: Service registration and discovery
+
+## Get started
+
+- Dubbo-rust Quick Start:
[中文](https://dubbo.apache.org/zh/docs3-v2/rust-sdk/quick-start/), English
+- Dubbo-rust Tutorials:
[Examples](https://github.com/apache/dubbo-rust/tree/main/examples)
+
+## Project structure
+
+```
+.
+├── Cargo.toml
+├── LICENSE
+├── README.md
+├── README_CN.md
+├── common
+│ ├── Cargo.toml
+│ └── src
+│ └── lib.rs
+├── config
+│ ├── Cargo.toml
+│ └── src
+│ ├── config.rs
+│ ├── lib.rs
+│ ├── protocol.rs
+│ └── service.rs
+├── contributing.md
+├── docs
+│ ├── filter-design.md
+│ ├── generic-protocol-design.md
+│ ├── readme.md
+│ └── services.md
+more ...
+```
+
+## Contact
+
+- [DingTalk Group](https://www.dingtalk.com/enhttps://www.dingtalk.com/en):
44694199
+
+## Contribute
+
+Welcome more developers to join us. About more details please check "[How to
contribute](https://github.com/apache/dubbo-rust/blob/main/contributing.md)".
+
+## License
+
+Apache Dubbo-rust software is licenced under the Apache License Version 2.0.
See the [LICENSE](https://github.com/apache/dubbo-rust/blob/main/LICENSE) file
for details.
diff --git a/README_CN.md b/README_CN.md
index e69de29..ba64a40 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -0,0 +1,75 @@
+# Apache Dubbo-rust
+
+<a href="https://dubbo.apache.org/";>
+ <img style="vertical-align: top;"
src="https://dubbo.apache.org/imgs/dubbo_colorful.png"; alt="logo"
height="45px"></a>
+
+Apache Dubbo-rust, Dubbo RPC框架的Rust实现。请访问 [Dubbo官网](https://dubbo.apache.org/)
查看更多信息.
+
+[](https://travis-ci.org/apache/dubbo-rust)
+
+## 概述
+
+Dubbo-rust 目前还在开发阶段. 截至目前, 已经实现了基于HTTP2的gRPC调用.
+
+以下为主要的依赖库:
+
+- [`Tokio`](https://github.com/tokio-rs/tokio) 使用Rust编写事件驱动、无阻塞I/O异步程序的框架。
+
+- [`Prost`](https://github.com/tokio-rs/prost/) [Protocol
Buffers](https://developers.google.com/protocol-buffers/) Rust实现。
+
+-
[`Hyper`](https://github.com/hyperium/hyperhttps://github.com/hyperium/hyper)
构建HTTP协议的Rust库。
+
+- [`Serde`](https://github.com/serde-rs/serde) 序列化/反序列化Rust库
+
+## 功能列表
+
+- :white_check_mark: RPC 异步/同步调用
+- :white_check_mark: IDL文件代码生成器
+- :construction: RPC多协议支持（如： Triple, Dubbo, gRPC, JSONRPC）
+- :construction: 支持 TCP/HTTP2 传输层协议
+- :construction: 服务注册与发现
+
+## 开始使用
+
+- Dubbo-rust 快速开始:
[中文](https://dubbo.apache.org/zh/docs3-v2/rust-sdk/quick-start/), English
+- Dubbo-rust 教程:
[Examples](https://github.com/apache/dubbo-rust/tree/main/examples)
+
+## 项目结构
+
+```
+.
+├── Cargo.toml
+├── LICENSE
+├── README.md
+├── README_CN.md
+├── common
+│ ├── Cargo.toml
+│ └── src
+│ └── lib.rs
+├── config
+│ ├── Cargo.toml
+│ └── src
+│ ├── config.rs
+│ ├── lib.rs
+│ ├── protocol.rs
+│ └── service.rs
+├── contributing.md
+├── docs
+│ ├── filter-design.md
+│ ├── generic-protocol-design.md
+│ ├── readme.md
+│ └── services.md
+more ...
+```
+
+## 联系方式
+
+- [钉钉](https://www.dingtalk.com/enhttps://www.dingtalk.com/en): 44694199
+
+## 贡献
+
+欢迎更多的开发者加入我们。关于更多的信息可以查看
[[CONTRIBUTING](https://github.com/apache/dubbo-rust/blob/main/contributing.md)]。
+
+## 许可证
+
+Apache Dubbo-rust 使用Apache许可证2.0版本。 请参考
[LICENSE](https://github.com/apache/dubbo-rust/blob/main/LICENSE) 文件获得更多信息。
\ No newline at end of file
![https://dubbo.apache.org/imgs/dubbo_colorful.png"](https://dubbo.apache.org/imgs/dubbo_colorful.png"){kind=link}
