📝 docs: update README before publishing to crates.io

Cargo.lock

@@ -11,7 +11,7 @@ dependencies = [
 
 [[package]]
 name = "always_equal"
-version = "1.0.1"
+version = "1.0.2"
 
 [[package]]
 name = "ansi_term"

crates/ptth_server/README.md

@@ -0,0 +1,31 @@
+# PTTH Server
+
+The PTTH server is an HTTP server that can serve files from
+behind a firewall, because it only makes outgoing HTTP connections
+to a PTTH relay.
+
+```
+View from outside the PTTH tunnel:
+
+* HTTP client
+|
+|   HTTP(S) requests
+V
+* ptth_relay
+^
+|   HTTP(S) requests
+|
+* ptth_server
+
+View from inside the PTTH tunnel:
+
+* HTTP client
+|
+|   HTTP(S) requests
+V
+* ptth_relay
+|
+|   HTTP(S) requests
+V
+* ptth_server
+```

crates/ptth_server/src/lib.rs

@@ -1,8 +1,34 @@
 //! # PTTH Server
 //! 
-//! The PTTH server makes outgoing HTTP connections to a
+//! The PTTH server is an HTTP server that can serve files from
-//! PTTH relay, and then serves incoming HTTP requests through
+//! behind a firewall, because it only makes outgoing HTTP connections
-//! the relay.
+//! to a PTTH relay.
+//! 
+//! ```
+//! View from outside the PTTH tunnel:
+//! 
+//! * HTTP client
+//! |
+//! |   HTTP(S) requests
+//! V
+//! * ptth_relay
+//! ^
+//! |   HTTP(S) requests
+//! |
+//! * ptth_server
+//! 
+//! View from inside the PTTH tunnel:
+//! 
+//! * HTTP client
+//! |
+//! |   HTTP(S) requests
+//! V
+//! * ptth_relay
+//! |
+//! |   HTTP(S) requests
+//! V
+//! * ptth_server
+//! ```
 
 #![warn (clippy::pedantic)]