From 4397841aaaa200c0c6d800062ca49e41666628ef Mon Sep 17 00:00:00 2001
From: Michael Lehmann <lehmschi@gmail.com>
Date: Tue, 6 Aug 2024 23:12:25 +0200
Subject: [PATCH] Add readme.

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71ee694
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# newsboat-yt
+Plugin to download / enqueue youtube videos from rss subscriptions in newsboat.
+
+## Dependencies / Requirements
+The following package are required.
+- yt-dlp
+- golang
+
+## Installation
+```bash
+sudo make install
+```
+
+## Uninstall
+```bash
+sudo make uninstall
+```
+
+## Usage
+```bash
+Usage of newsboat-yt:
+  -d    start downloading from queue.
+  -u string
+        add url to download queue.
+```