feat(docs): update readme

This commit is contained in:
2026-01-25 13:23:57 +03:00
parent ad31687111
commit 61a6fcee03

View File

@@ -1,32 +1,51 @@
# Trackers
Опрашивает ссылки со списками torrent-трекеров,
соединяет их в один список. Поддерживает кеширование,
http, file источники.
A torrent tracker aggregator that polls multiple sources and serves a unified,
deduplicated list of tracker URLs via HTTP API.
Учебный проект.
**Educational project written in Go 1.25.5**
## Запуск
## Features
- Polls tracker sources at configurable intervals
- Supports HTTP/HTTPS and local file sources
- Deduplicates and validates tracker URLs
- Persistent disk caching for resilience
- HTTP proxy support via environment variables
- Request logging for monitoring
- Single binary with minimal dependencies
## Usage
```shell
trackers --config config.toml
trackers -config config.toml
```
Получение списка трекеров:
Get the aggregated tracker list:
```shell
curl http://127.0.0.1:8080/list
```
## Конфигурация
## Configuration
Источники для трекеров описываются в toml-конфиге:
See [config.dist.toml](config.dist.toml) for a complete configuration example with comments.
```toml
port = 8080
Copy the example file and customize:
sources = [
"https://example.com",
"file:///home/user/local-file.txt",
]
```shell
cp config.dist.toml config.toml
# Edit config.toml with your sources
```
## Proxy Support
HTTP requests respect standard proxy environment variables:
```shell
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080
trackers -config config.toml
```
See [config.dist.toml](config.dist.toml) for details.