📝 docs: add README to `ptth_relay` before publishing
parent
2c4d46388a
commit
d001d9efe5
|
@ -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.
|
|
@ -1,7 +1,8 @@
|
||||||
//! # PTTH Relay
|
//! # PTTH Relay
|
||||||
//!
|
//!
|
||||||
//! ptth_relay runs on a public-facing web server and accepts
|
//! The PTTH relay accepts incoming connections from PTTH servers, and
|
||||||
//! incoming HTTP connections from both HTTP clients and PTTH servers.
|
//! acts as a reverse proxy, forwarding incoming requests from HTTP clients
|
||||||
|
//! to PTTH servers.
|
||||||
|
|
||||||
#![warn (clippy::pedantic)]
|
#![warn (clippy::pedantic)]
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue