diff --git a/README.md b/README.md index 48831ce..fb29384 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ # magnet-to-torrent +A tiny CLI tool to fetch torrent metadata from a magnet link and save it as a `.torrent` file. + +## Install + +```bash +# Clone and build +git clone https://codeberg.org/firebadnofire/magnet-to-torrent.git +cd magnet-to-torrent +make build +# or: +go build -o magnet-to-torrent main.go +``` + +## Usage + +```bash +magnet-to-torrent [options] +``` + +### Options + +* `-o ` Output filename (default: `.torrent`) +* `-timeout ` Metadata timeout (default: `5m`) +* `-upload` Enable seeding after fetch (off by default) + +## License + +MIT © FireBADnoFire +