From 0ed18cf35139b189376403f4da3633d60a2077be Mon Sep 17 00:00:00 2001
From: firebadnofire <william@archuser.org>
Date: Sun, 4 May 2025 14:04:18 -0400
Subject: [PATCH] update docs

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

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] <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
+