From d46d2b15ba38ec009de8f9702737d66d4e687453 Mon Sep 17 00:00:00 2001
From: Joren <jorenschip@gmail.com>
Date: Tue, 3 Sep 2024 23:23:27 +0200
Subject: [PATCH] Add simple readme

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

diff --git a/README.md b/README.md
index e69de29..c90ddca 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,39 @@
+# DRMDtool
+
+drmdtool is a utility for processing .drmd files using N_m3u8DL-RE.
+
+## Configuration
+
+Create a `config.toml` file in the same directory as the drmdtool executable:
+
+```toml
+BaseDir = "/path/to/save/downloads"
+Format = "mkv"
+
+[N_m3u8DL-RE]
+Path = "/path/to/N_m3u8DL-RE"
+```
+
+Adjust the paths and format as needed. (mkv, mp4)
+
+## Web UI Usage
+
+1. Run the executable:
+   ```
+   ./drmdtool
+   ```
+
+2. Open a web browser and go to `http://localhost:8080`
+
+3. Use the interface to upload .drmd files and monitor download progress
+
+
+## CLI Usage
+
+To process a file directly from the command line:
+
+```
+./drmdtool -f /path/to/file.drmd
+```
+
+This will download the file and save it in the base directory specified in the config.
\ No newline at end of file