Add separate READMEs for bencher, peer_id and all protocol crates

crates/bencher/README.md

@@ -1,3 +1,11 @@
 # aquatic_bencher
 
 Automated benchmarking of aquatic and other BitTorrent trackers. Linux only.
+
+## Supported trackers by protocol
+
+### UDP
+
+- [aquatic_udp](https://github.com/greatest-ape/aquatic/)
+- [opentracker](https://erdgeist.org/arts/software/opentracker/)
+- [chihaya](https://github.com/chihaya/chihaya)

crates/http_protocol/Cargo.toml

@@ -7,9 +7,10 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-readme.workspace = true
 rust-version.workspace = true
 
+readme = "./README.md"
+
 [lib]
 name = "aquatic_http_protocol"
 

crates/http_protocol/README.md

@@ -0,0 +1,15 @@
+# aquatic_http_protocol: HTTP BitTorrent tracker protocol
+
+HTTP BitTorrent tracker message parsing and serialization.
+
+[BEP 003]: https://www.bittorrent.org/beps/bep_0003.html
+[BEP 007]: https://www.bittorrent.org/beps/bep_0007.html
+[BEP 023]: https://www.bittorrent.org/beps/bep_0023.html
+[BEP 048]: https://www.bittorrent.org/beps/bep_0048.html
+
+Implements:
+  * [BEP 003]: HTTP BitTorrent protocol ([more details](https://wiki.theory.org/index.php/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol)). Exceptions:
+    * Only compact responses are supported
+  * [BEP 023]: Compact HTTP responses
+  * [BEP 007]: IPv6 support
+  * [BEP 048]: HTTP scrape support

crates/peer_id/Cargo.toml

@@ -6,9 +6,10 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-readme.workspace = true
 rust-version.workspace = true
 
+readme = "./README.md"
+
 [lib]
 name = "aquatic_peer_id"
 

crates/peer_id/README.md

@@ -0,0 +1,3 @@
+# aquatic_peer_id
+
+Extract BitTorrent client information from announce request peer IDs.

crates/udp_protocol/Cargo.toml

@@ -7,9 +7,10 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-readme.workspace = true
 rust-version.workspace = true
 
+readme = "./README.md"
+
 [dependencies]
 aquatic_peer_id.workspace = true
 

crates/udp_protocol/README.md

@@ -0,0 +1,4 @@
+# aquatic_udp_protocol: UDP BitTorrent tracker protocol
+
+[UDP BitTorrent](https://www.bittorrent.org/beps/bep_0015.html) tracker
+message parsing and serialization.

crates/ws_protocol/Cargo.toml

@@ -8,9 +8,10 @@ authors.workspace = true
 edition.workspace = true
 license.workspace = true
 repository.workspace = true
-readme.workspace = true
 rust-version.workspace = true
 
+readme = "./README.md"
+
 [lib]
 name = "aquatic_ws_protocol"
 

crates/ws_protocol/README.md

@@ -0,0 +1,4 @@
+# aquatic_ws_protocol: WebTorrent tracker protocol
+
+[WebTorrent](https://github.com/webtorrent) tracker message parsing and
+serialization.