add usage example

This commit is contained in:
yggverse 2025-09-09 11:27:25 +03:00
parent fc830fa3be
commit 201be59670

View file

@ -11,3 +11,21 @@ Shared BitTorrent scrape API for the βtracker project components
``` bash ``` bash
cargo add btracker-scrape cargo add btracker-scrape
``` ```
## Usage
``` rust
let udp_server = vec![
SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0)),
SocketAddr::V6(SocketAddrV6::new(Ipv6Addr::UNSPECIFIED, 0, 0, 0))
];
let udp_trackers = vec![
SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 6969))
];
let scrape = Scrape::init(Some(udp_server, udp_trackers));
println!("{:?}", scrape.get([u8; 20])); // hash v1
```
* see [btracker](https://github.com/YGGverse/btracker) and [btracker-gemini](https://github.com/YGGverse/btracker-gemini) implementations