Add Readme and crate docs for ttrpc-rust compiler

ready for publish

Signed-off-by: Tim Zhang <[email protected]>

Author: Tim-Zhang

compiler/README.md

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

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;