Merge pull request #44 from Tim-Zhang/docs-and-publish

Docs and publish

Author: Hui Zhu

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ttrpc"
-version = "0.4.0"
+version = "0.4.1"
 authors = ["The AntFin Kata Team <[email protected]>"]
 edition = "2018"
 license = "Apache-2.0"
@@ -32,3 +32,6 @@ protobuf-codec = ["protobuf"]
 async = ["async-trait", "tokio", "futures", "tokio-vsock"]
 sync = []
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

README.md

@@ -13,9 +13,8 @@ To generate the sources from proto files:
 
 1. Install protoc from github.com/protocolbuffers/protobuf
 
-2. Install protobuf-codegen from github.com/pingcap/grpc-rs
+2. Install protobuf-codegen
 ```
-cd grpc-rs
 cargo install --force protobuf-codegen
 ```
 
@@ -57,10 +56,10 @@ ttrpc-rust supports async/.await. By using async/.await you can reduce the overh
 
 ## Usage
 ### 1. Generate codes in async version
-Currently we only support generating async codes by using protoc_rust_ttrpc
+Currently we only support generating async codes by using ttrpc-codegen
 
 ```
-    protoc_rust_ttrpc::Codegen::new()
+    ttrpc_codegen::Codegen::new()
         .out_dir("protocols/asynchronous")
         .inputs(&protos)
         .include("protocols/protos")

compiler/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ttrpc-compiler"
-version = "0.3.1"
+version = "0.3.2"
 edition = "2018"
 authors = ["The AntFin Kata Team <[email protected]>"]
 license = "Apache-2.0"
@@ -9,6 +9,7 @@ description = "ttRPC compiler for ttrpc"
 categories = ["network-programming"]
 repository = "https://github.com/containerd/ttrpc-rust/tree/master/compiler"
 homepage = "https://github.com/containerd/ttrpc-rust/tree/master/compiler"
+readme = "README.md"
 
 [dependencies]
 protobuf = "2.0"

compiler/README.md

@@ -1,6 +1,6 @@
 # A compiler of ttrpc-rust
 
-generate rust version ttrpc codes from proto files.
+generate rust version ttrpc code from proto files.
 
 ## Usage
 

compiler/src/lib.rs

@@ -14,7 +14,7 @@
 //!
 //! A compiler of ttrpc-rust.
 //!
-//! *generate rust version ttrpc codes from proto files.*
+//! *generate rust version ttrpc code from proto files.*
 //!
 //!
 //! Usage
@@ -27,9 +27,13 @@ pub mod codegen;
 pub mod prost_codegen;
 mod util;
 
+/// Customize generated code.
 #[derive(Default, Debug, Clone)]
 pub struct Customize {
+    /// Indicates whether to generate async code for both server and client.
     pub async_all: bool,
+    /// Indicates whether to  generate async code for client.
     pub async_client: bool,
+    /// Indicates whether to generate async code for server.
     pub async_server: bool,
 }