update docs

This commit is contained in:
firebadnofire 2025-05-04 14:04:18 -04:00
parent 4a0d1a288b
commit 0ed18cf351
Signed by: firebadnofire
SSH key fingerprint: SHA256:bnN1TGRauJN84CxL1IZ/2uHNvJualwYkFjOKaaOilJE

View file

@ -1,2 +1,31 @@
# magnet-to-torrent # 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] <magnet_link>
```
### Options
* `-o <file>` Output filename (default: `<torrent name>.torrent`)
* `-timeout <dur>` Metadata timeout (default: `5m`)
* `-upload` Enable seeding after fetch (off by default)
## License
MIT © FireBADnoFire