📝 docs: add README to `ptth_relay` before publishing

main
_ 2021-04-18 13:06:01 -05:00
parent 2c4d46388a
commit d001d9efe5
2 changed files with 8 additions and 2 deletions

View File

@ -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.

View File

@ -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)]