diff --git a/README.md b/README.md index c7865f1..b5a1e03 100644 --- a/README.md +++ b/README.md @@ -10,4 +10,22 @@ Shared BitTorrent scrape API for the βtracker project components ``` bash cargo add btracker-scrape -``` \ No newline at end of file +``` + +## 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 \ No newline at end of file