From a0c79970fed5384cd9e983583edd30aa3dbd8f4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Sat, 27 Jan 2024 18:05:21 +0100 Subject: [PATCH] Add separate READMEs for bencher, peer_id and all protocol crates --- crates/bencher/README.md | 10 +++++++++- crates/http_protocol/Cargo.toml | 3 ++- crates/http_protocol/README.md | 15 +++++++++++++++ crates/peer_id/Cargo.toml | 3 ++- crates/peer_id/README.md | 3 +++ crates/udp_protocol/Cargo.toml | 3 ++- crates/udp_protocol/README.md | 4 ++++ crates/ws_protocol/Cargo.toml | 3 ++- crates/ws_protocol/README.md | 4 ++++ 9 files changed, 43 insertions(+), 5 deletions(-) create mode 100644 crates/http_protocol/README.md create mode 100644 crates/peer_id/README.md create mode 100644 crates/udp_protocol/README.md create mode 100644 crates/ws_protocol/README.md diff --git a/crates/bencher/README.md b/crates/bencher/README.md index 70cc8a0..224f638 100644 --- a/crates/bencher/README.md +++ b/crates/bencher/README.md @@ -1,3 +1,11 @@ # aquatic_bencher -Automated benchmarking of aquatic and other BitTorrent trackers. Linux only. \ No newline at end of file +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) \ No newline at end of file diff --git a/crates/http_protocol/Cargo.toml b/crates/http_protocol/Cargo.toml index be0273f..b373072 100644 --- a/crates/http_protocol/Cargo.toml +++ b/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" diff --git a/crates/http_protocol/README.md b/crates/http_protocol/README.md new file mode 100644 index 0000000..f618dae --- /dev/null +++ b/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 \ No newline at end of file diff --git a/crates/peer_id/Cargo.toml b/crates/peer_id/Cargo.toml index 4acc099..338bd8c 100644 --- a/crates/peer_id/Cargo.toml +++ b/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" diff --git a/crates/peer_id/README.md b/crates/peer_id/README.md new file mode 100644 index 0000000..010f1bf --- /dev/null +++ b/crates/peer_id/README.md @@ -0,0 +1,3 @@ +# aquatic_peer_id + +Extract BitTorrent client information from announce request peer IDs. \ No newline at end of file diff --git a/crates/udp_protocol/Cargo.toml b/crates/udp_protocol/Cargo.toml index cd4614d..2142ccf 100644 --- a/crates/udp_protocol/Cargo.toml +++ b/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 diff --git a/crates/udp_protocol/README.md b/crates/udp_protocol/README.md new file mode 100644 index 0000000..1b49ec7 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/crates/ws_protocol/Cargo.toml b/crates/ws_protocol/Cargo.toml index df05b2d..4ae72de 100644 --- a/crates/ws_protocol/Cargo.toml +++ b/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" diff --git a/crates/ws_protocol/README.md b/crates/ws_protocol/README.md new file mode 100644 index 0000000..f17b8be --- /dev/null +++ b/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. \ No newline at end of file