From f8b82e9edf0609946ca350e85b65c63b0ef45871 Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Wed, 4 Sep 2024 12:25:24 +0100 Subject: [PATCH] docs: update README --- README.md | 6 ++++++ cSpell.json | 1 + 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index a266a3d..57c3479 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Torrust Hash2Torrent +[![Testing](https://github.com/torrust/torrust-hash2torrent/actions/workflows/testing.yaml/badge.svg)](https://github.com/torrust/torrust-hash2torrent/actions/workflows/testing.yaml) [![Container](https://github.com/torrust/torrust-hash2torrent/actions/workflows/container.yaml/badge.svg)](https://github.com/torrust/torrust-hash2torrent/actions/workflows/container.yaml) + A web service to get torrents' metadata from the infohashes. The API is based on the Rust BitTorrent client [rqbit](). The client uses [BEP 9](https://www.bittorrent.org/beps/bep_0009.html) to get the Metadata Files from other peers. @@ -38,3 +40,7 @@ Or with the browser: > NOTICE: The BitTorrent client may not find the torrent and the HTTP could return a 408 (timeout) error after 10 You can check the API with the health_check endpoint: + +## Acknowledgments + +[ikatson]() main contributor to [rqbit](https://github.com/ikatson/rqbit). diff --git a/cSpell.json b/cSpell.json index e6bd71e..025afaa 100644 --- a/cSpell.json +++ b/cSpell.json @@ -12,6 +12,7 @@ "comms", "Containerfile", "distroless", + "ikatson", "infohash", "librqbit", "libz",