update readme

This commit is contained in:
yggverse 2025-08-07 16:03:12 +03:00
parent 1150f93817
commit 92fbd25c9c

View file

@ -34,10 +34,18 @@
## Usage ## Usage
``` bash ``` bash
btracker --preload /path/to/aquatic-crawler/preload btracker --preload=/path/to/aquatic-crawler/preload\
--scrape=udp://127.0.0.1:6969\
--tracker=udp://[302:68d0:f0d5:b88d::fdb]:6969\
--tracker=udp://tracker.ygg:6969
``` ```
* append `RUST_LOG=debug` for detailed information output * The `--scrape` argument is optional and enables statistics for peers, seeders, and leechers
* see the project [Wiki](https://github.com/YGGverse/btracker/wiki) for more details (including [systemd](https://github.com/YGGverse/btracker/wiki/Systemd) and [nginx](https://github.com/YGGverse/btracker/wiki/Nginx) examples) * it is recommended to use the local address for faster performance
* supports multiple providers on both the IPv4 and IPv6 stacks
* take a look at the `--udp` option if you want to customize the default binding for UDP scrapes
* Define as many `--tracker`(s) as required
* Append `RUST_LOG=debug` for detailed information output
* See the project [Wiki](https://github.com/YGGverse/btracker/wiki) for more details (including [systemd](https://github.com/YGGverse/btracker/wiki/Systemd) and [nginx](https://github.com/YGGverse/btracker/wiki/Nginx) examples)
### Options ### Options