diff --git a/Cargo.toml b/Cargo.toml index 4fcc41c..f739b7e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,6 +6,21 @@ authors = ["Trish"] edition = "2018" license = "AGPL-3.0" +description = "An extroverted HTTP server that can run behind firewalls" +repository = "https://github.com/ReactorScram/ptth" +readme = "README.md" +keywords = ["http", "tunnel", "firewall"] +categories = ["command-line-utilities", "web-programming::http-server"] + +exclude = [ + "README.md", + "assets", + "bare_minimum_crypto/cpp", + "docs", + "issues", + "todo.md", +] + [dependencies] [dev-dependencies] diff --git a/README.md b/README.md index 1b4919d..400a29c 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ firewalls. ``` HTTP: -Client --> Firewall --> Server +Client -> Firewall -> Server PTTH: -Client --> Firewall --> Relay <-- Firewall <-- Server +Client -> Firewall -> Relay <- Firewall <- Server ``` The server can run behind a firewall, because it is actually a special HTTP @@ -217,9 +217,7 @@ HTTP tunnel. The `http_serde` module is shared by ptth_relay and ptth_server so that they can communicate with each other easily. -## Why are GitHub issues disabled? - -Because they are not part of Git. +## How should I report bugs or request features? For now, either email me (if you know me personally) or make a pull request to add an item to [todo.md](todo.md). diff --git a/crates/ptth_core/Cargo.toml b/crates/ptth_core/Cargo.toml index 79d0a72..872b82a 100644 --- a/crates/ptth_core/Cargo.toml +++ b/crates/ptth_core/Cargo.toml @@ -6,6 +6,9 @@ authors = ["Trish"] edition = "2018" license = "AGPL-3.0" +description = "Common code for the PTTH relay and server" +repository = "https://github.com/ReactorScram/ptth" + [dependencies] ctrlc = { version = "3.1.7", features = [ "termination" ] } diff --git a/quic-plan.md b/quic-plan.md deleted file mode 100644 index c5e98ad..0000000 --- a/quic-plan.md +++ /dev/null @@ -1,5 +0,0 @@ -# The QUIC plan - -Use QUIC to tunnel arbitrary UDP / TCP connections through the relay. - -