From 5633a889a22cb93d75376b0e820f87eb085b9fb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Thu, 9 Mar 2023 23:19:40 +0100 Subject: [PATCH] Improve README --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aa08ff7..d604f8b 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Features at a glance: - Supports forbidding/allowing info hashes - Built-in TLS support (no reverse proxy needed) - Automated CI testing of full file transfers +- Prometheus metrics Known users: @@ -192,10 +193,9 @@ This is the most mature of the implementations. I consider it ready for producti #### io_uring -An experimental io_uring backend can be enabled by passing the `io-uring` -feature when compilinig. Currently, Linux 6.0 or later is required. The -application will attempt to fall back to the [mio] backend if your kernel is -not supported. +An experimental io_uring backend is available. It currently requires Linux +6.0 or later and will attempt to fall back to the [mio] backend if run with +older kernels. To enable it, pass the `io-uring` feature when compiling: ```sh cargo build --release -p aquatic_udp --features "io-uring" @@ -205,7 +205,9 @@ cargo build --release -p aquatic_udp --features "io-uring" ![UDP BitTorrent tracker throughput comparison](./documents/aquatic-udp-load-test-illustration-2023-01-11.png) -More details are available [here](./documents/aquatic-udp-load-test-2023-01-11.pdf). The mio backend was used. +The mio backend was used. More details are available [here](./documents/aquatic-udp-load-test-2023-01-11.pdf). + +--- ### aquatic_http: HTTP BitTorrent tracker @@ -237,6 +239,8 @@ without knowing the exact setup. More details are available [here](./documents/aquatic-http-load-test-2023-01-25.pdf). +--- + ### aquatic_ws: WebTorrent tracker Aims for compatibility with [WebTorrent](https://github.com/webtorrent)