Add separate READMEs for bencher, peer_id and all protocol crates

This commit is contained in:
Joakim Frostegård 2024-01-27 18:05:21 +01:00
parent 7d4ba6940b
commit a0c79970fe
9 changed files with 43 additions and 5 deletions

View file

@ -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"

View file

@ -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