Merge pull request #7 from sevki/dev

remove dupe file

README.md

@@ -3,13 +3,13 @@
 #  JetStream [![crates.io](https://img.shields.io/crates/v/jetstream.svg)](https://crates.io/crates/jetstream) [![docs.rs](https://docs.rs/jetstream/badge.svg)](https://docs.rs/jetstream) <!--gh actions--> ![Build Status](https://github.com/sevki/jetstream/actions/workflows/rust.yml/badge.svg) ![Build Status](https://github.com/sevki/jetstream/actions/workflows/release.yml/badge.svg)
 
 
-JetStream is an RPC framework built on top of s2n-quic and p9.
+JetStream is an RPC framework built on top of [s2n-quic](https://crates.io/crates/s2n-quic) and [p9](https://crates.io/crates/p9). It's designed to be a high performance, low latency, secure, and reliable RPC framework.
 
 Features:
 
 - Bidirectional streaming
 - 0-RTT
-- mTLS
+- [mTLS](https://github.com/aws/s2n-quic/tree/main/examples/s2n-mtls)
 - binary encoding
 
 ## Motivation

src/log.rs

@@ -22,13 +22,13 @@ fn get_module_colour(module: &str) -> Color {
     color
 }
 
-pub fn setup_logging() -> Logger {
+pub(crate) fn setup_logging() -> Logger {
     let x = drain();
 
     slog::Logger::root(x, slog_o!())
 }
 
-pub fn drain() -> slog::Fuse<
+pub(crate) fn drain() -> slog::Fuse<
     slog_term::FullFormat<slog_term::PlainSyncDecorator<std::io::Stdout>>,
 > {
     let plain = slog_term::PlainSyncDecorator::new(std::io::stdout());

src/service.rs

@@ -11,6 +11,7 @@ use tower::Service;
 
 pub use jetstream_p9_wire_format_derive::P9WireFormat;
 
+/// Message trait for JetStream messages, which need to implement the `WireFormat` trait.
 pub trait Message: WireFormat + Send + Sync {}
 
 /// A trait for implementing a 9P service.