Merge pull request #42 from Tim-Zhang/update-compiler

Update compiler for publish

Author: Hui Zhu

compiler/Cargo.toml

@@ -1,12 +1,14 @@
 [package]
 name = "ttrpc-compiler"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2018"
 authors = ["The AntFin Kata Team <[email protected]>"]
 license = "Apache-2.0"
 keywords = ["compiler", "ttrpc", "protobuf"]
 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"
 
 [dependencies]
 protobuf = "2.0"

compiler/README.md

@@ -0,0 +1,8 @@
+# A compiler of ttrpc-rust
+
+generate rust version ttrpc codes from proto files.
+
+## Usage
+
+- [Manual Generation](https://github.com/containerd/ttrpc-rust#1-generate-with-protoc-command) uses ttrpc-compiler as a protoc plugin
+- [Programmatic Generation](https://github.com/containerd/ttrpc-rust#2-generate-programmatically) uses ttrpc-compiler as a rust crate

compiler/src/lib.rs

@@ -11,6 +11,18 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//!
+//! A compiler of ttrpc-rust.
+//!
+//! *generate rust version ttrpc codes from proto files.*
+//!
+//!
+//! Usage
+//!
+//!- [Manual Generation](https://github.com/containerd/ttrpc-rust#1-generate-with-protoc-command) uses ttrpc-compiler as a protoc plugin
+//!
+//!- [Programmatic Generation](https://github.com/containerd/ttrpc-rust#2-generate-programmatically) uses ttrpc-compiler as a rust crate
+
 pub mod codegen;
 pub mod prost_codegen;
 mod util;