From 8f80d0f6d1d579ca98570bd9c950a7dd1845f1d1 Mon Sep 17 00:00:00 2001 From: Lucio Franco Date: Tue, 1 Oct 2019 19:34:45 -0400 Subject: [PATCH] chore(docs): Update tonic-build docs (#22) --- tonic-build/src/lib.rs | 17 +++++++++++++++++ tonic-examples/Cargo.toml | 1 - 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/tonic-build/src/lib.rs b/tonic-build/src/lib.rs index 9038379..9d04a2a 100644 --- a/tonic-build/src/lib.rs +++ b/tonic-build/src/lib.rs @@ -1,6 +1,23 @@ //! `tonic-build` compiles `proto` files via `prost` and generates service stubs //! and proto definitiones for use with `tonic`. //! +//! # Features +//! +//! `tonic-build` only comes with one `rustfmt` feature which enables the usage of +//! the `rustfmt` binary to format the generated code. This is enabled by default. +//! +//! # Required dependencies +//! +//! ```toml +//! [dependencies] +//! bytes = +//! tonic = +//! prost = +//! +//! [build-dependencies] +//! tonic-build = +//! ``` +//! //! # Examples //! Simple //! diff --git a/tonic-examples/Cargo.toml b/tonic-examples/Cargo.toml index 78c34c3..141a6e0 100644 --- a/tonic-examples/Cargo.toml +++ b/tonic-examples/Cargo.toml @@ -48,7 +48,6 @@ path = "src/tls/server.rs" tonic = { path = "../tonic", features = ["rustls"] } bytes = "0.4" prost = "0.5" -prost-derive = "0.5" tokio = "=0.2.0-alpha.6" futures-preview = { version = "=0.3.0-alpha.19", default-features = false, features = ["alloc"]}