chore: Adjust docs (#8)

* adjust `README`

Add CI badge, adjust example, add 'compatibility' section.

* envoy-types: adjust `lib.rs` doc

Changes in line with `README` adjustments.

Author: flemosr

README.md

@@ -6,9 +6,10 @@ through Rust gRPC services.
 Among other use cases, this crate can be used to implement an
 [Envoy External Authorization] (ExtAuthz) gRPC Server written in Rust.
 
-[![Crates.io](https://img.shields.io/crates/v/envoy-types)](https://crates.io/crates/envoy-types)
-[![Documentation](https://docs.rs/envoy-types/badge.svg)](https://docs.rs/envoy-types)
-[![Crates.io](https://img.shields.io/crates/l/envoy-types)](LICENSE)
+[![Crates.io Badge](https://img.shields.io/crates/v/envoy-types)](https://crates.io/crates/envoy-types)
+[![Documentation Badge](https://docs.rs/envoy-types/badge.svg)](https://docs.rs/envoy-types)
+[![License Badge](https://img.shields.io/crates/l/envoy-types)](LICENSE)
+![CI Badge](https://github.com/flemosr/envoy-types/actions/workflows/ci.yml/badge.svg)
 
 [Examples] | [Docs]
 
@@ -37,6 +38,7 @@ including query parameters and header manipulation, can be found at the
 [examples] directory.
 
 ```rust
+use std::env;
 use tonic::{transport::Server, Request, Response, Status};
 
 use envoy_types::ext_authz::v3::pb::{
@@ -73,8 +75,9 @@ impl Authorization for MyServer {
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let addr = format!("0.0.0.0:50051").parse().unwrap();
-    let server = MyServer::default();
+    let server_port = env::var("SERVER_PORT").unwrap_or("50051".into());
+    let addr = format!("0.0.0.0:{server_port}").parse().unwrap();
+    let server = MyServer;
 
     println!("AuthorizationServer listening on {addr}");
 
@@ -87,9 +90,17 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 }
 ```
 
-You can check the currently supported version of [`tonic`] at this crate's
-[`Cargo.toml`] file. If you want to work with a previous version, consider
-using a [previous version of `envoy-types`].
+## Compatibility
+
+The table bellow outlines the correspondence between the versions of [`tonic`]
+and the compatible versions of [`envoy-types`].
+
+`tonic` | `envoy-types`
+:-      | :-
+v0.12   | [v0.5](https://crates.io/crates/envoy-types/0.5.3)
+v0.11   | [v0.4](https://crates.io/crates/envoy-types/0.4.0)
+v0.10   | [v0.3](https://crates.io/crates/envoy-types/0.3.0)
+v0.9    | [v0.2](https://crates.io/crates/envoy-types/0.2.0)
 
 ## License
 
@@ -104,8 +115,7 @@ terms or conditions.
 [Envoy Proxy]: https://www.envoyproxy.io
 [Envoy External Authorization]: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_authz_filter
 [examples]: https://github.com/flemosr/envoy-types/tree/main/examples
-[`Cargo.toml`]: https://github.com/flemosr/envoy-types/blob/main/envoy-types/Cargo.toml
-[previous version of `envoy-types`]: https://crates.io/crates/envoy-types/versions
+[`envoy-types`]: https://crates.io/crates/envoy-types
 [Docs]: https://docs.rs/envoy-types/latest/envoy_types
 [protoc-install]: https://grpc.io/docs/protoc-installation/
 [`tonic`]: https://github.com/hyperium/tonic

envoy-types/src/lib.rs

@@ -30,6 +30,7 @@ query parameters and header manipulation, can be found at the [examples]
 directory.
 
 ```rust
+use std::env;
 use tonic::{transport::Server, Request, Response, Status};
 
 use envoy_types::ext_authz::v3::pb::{
@@ -66,8 +67,9 @@ impl Authorization for MyServer {
 
 // #[tokio::main]
 // async fn main() -> Result<(), Box<dyn std::error::Error>> {
-//     let addr = format!("0.0.0.0:50051").parse().unwrap();
-//     let server = MyServer::default();
+//     let server_port = env::var("SERVER_PORT").unwrap_or("50051".into());
+//     let addr = format!("0.0.0.0:{server_port}").parse().unwrap();
+//     let server = MyServer;
 
 //     println!("AuthorizationServer listening on {addr}");
 
@@ -80,17 +82,24 @@ impl Authorization for MyServer {
 // }
 ```
 
-You can check the currently supported version of [`tonic`] at this crate's
-[`Cargo.toml`] file. If you want to work with a previous version, consider
-using a [previous version of `envoy-types`].
+# Compatibility
+
+The table bellow outlines the correspondence between the versions of [`tonic`]
+and the compatible versions of [`envoy-types`].
+
+`tonic` | `envoy-types`
+:-      | :-
+v0.12   | [v0.5](https://crates.io/crates/envoy-types/0.5.3)
+v0.11   | [v0.4](https://crates.io/crates/envoy-types/0.4.0)
+v0.10   | [v0.3](https://crates.io/crates/envoy-types/0.3.0)
+v0.9    | [v0.2](https://crates.io/crates/envoy-types/0.2.0)
 
 [Envoy Proxy]: https://www.envoyproxy.io
 [Envoy External Authorization]: https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_authz_filter
 [protoc-install]: https://grpc.io/docs/protoc-installation/
 [`tonic`]: https://github.com/hyperium/tonic
 [examples]: https://github.com/flemosr/envoy-types/tree/main/examples
-[`Cargo.toml`]: https://github.com/flemosr/envoy-types/blob/main/envoy-types/Cargo.toml
-[previous version of `envoy-types`]: https://crates.io/crates/envoy-types/versions
+[`envoy-types`]: https://crates.io/crates/envoy-types
 */
 
 #![warn(missing_debug_implementations, rust_2018_idioms)]