diff --git a/crates/ptth_relay/README.md b/crates/ptth_relay/README.md new file mode 100644 index 0000000..0907c7e --- /dev/null +++ b/crates/ptth_relay/README.md @@ -0,0 +1,5 @@ +# PTTH Relay + +The PTTH relay accepts incoming connections from PTTH servers, and +acts as a reverse proxy, forwarding incoming requests from HTTP clients +to PTTH servers. diff --git a/crates/ptth_relay/src/lib.rs b/crates/ptth_relay/src/lib.rs index 7c265ce..c6921d7 100644 --- a/crates/ptth_relay/src/lib.rs +++ b/crates/ptth_relay/src/lib.rs @@ -1,7 +1,8 @@ //! # PTTH Relay //! -//! ptth_relay runs on a public-facing web server and accepts -//! incoming HTTP connections from both HTTP clients and PTTH servers. +//! The PTTH relay accepts incoming connections from PTTH servers, and +//! acts as a reverse proxy, forwarding incoming requests from HTTP clients +//! to PTTH servers. #![warn (clippy::pedantic)]