From 6c811140ec6517a05950196921258e84a8ef2385 Mon Sep 17 00:00:00 2001 From: Lucio Franco Date: Tue, 24 Sep 2019 21:32:01 -0400 Subject: [PATCH] Try readme banner --- README.md | 5 +++++ tonic/src/lib.rs | 14 +++++++++++--- 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..500ed07 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Tonic + +

+ Vector +

diff --git a/tonic/src/lib.rs b/tonic/src/lib.rs index c602fa5..639057a 100644 --- a/tonic/src/lib.rs +++ b/tonic/src/lib.rs @@ -23,12 +23,20 @@ //! # Feature Flags //! //! - `transport`: Enables the fully featured, batteries included client and server -//! implementaiton based on [`hyper`], [`tower`] and [`tokio`]. +//! implementation based on [`hyper`], [`tower`] and [`tokio`]. Enabled by default. //! - `codegen`: Enables all the required exports and optional dependencies required -//! for [`tonic-build`]. +//! for [`tonic-build`]. Enabled by default. +//! - `openssl`: Enables the `openssl` based tls options for the `transport` feature`. Not +//! enabled by default. +//! - `rustls`: Enables the `ruslts` based tls options for the `transport` feature`. Not +//! enabled by default. //! +//! # Structure //! -//! # Generic implementation +//! ## Generic implementation +//! +//! The main goal of [`tonic`] is to provide a generic gRPC implementation over http2.0 +//! framing. This means at the lowest level this library provides the ability to //! //! TODO: write generic implementation docs //!