From a24a10c518f9648bdd7bd06a2ef58f78989d6d7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Thu, 28 Oct 2021 17:36:11 +0200 Subject: [PATCH] README: write implementation list as table --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6249884..017494d 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,20 @@ Blazingly fast, multi-threaded BitTorrent tracker written in Rust. Consists of three sub-implementations for different protocols: - * `aquatic_udp`: BitTorrent over UDP. Implementation achieves 45% higher throughput - than opentracker (see benchmarks below) - * `aquatic_http`: BitTorrent over HTTP/TLS (slightly experimental) - * `aquatic_ws`: WebTorrent (experimental) + +[BitTorrent over UDP]: https://libtorrent.org/udp_tracker_protocol.html +[BitTorrent over HTTP]: https://wiki.theory.org/index.php/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol +[WebTorrent]: https://github.com/webtorrent +[rustls]: https://github.com/rustls/rustls +[native-tls]: https://github.com/sfackler/rust-native-tls +[mio]: https://github.com/tokio-rs/mio +[glommio]: https://github.com/DataDog/glommio + +| Name | Protocol | OS requirements | +|--------------|-----------------------------------------------|-----------------------------------------------------------------| +| aquatic_udp | [BitTorrent over UDP] | Cross-platform with [mio] (default) / Linux 5.8+ with [glommio] | +| aquatic_http | [BitTorrent over HTTP] with TLS ([rustls]) | Linux 5.8+ | +| aquatic_ws | [WebTorrent], plain / with TLS ([native-tls]) | Cross-platform | ## Copyright and license