From 50a50ffa59608838e21e63ba288f584be21a1c08 Mon Sep 17 00:00:00 2001
From: sinanmohd <sinan@sinanmohd.com>
Date: Mon, 2 Oct 2023 15:08:13 +0530
Subject: readme: init

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a77334
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+**MpvSUB: /comfy/ subtitles for Mpv without api keys or Python**
+----------------------------------------------------------------
+
+mpvsub automatically fetches subtitles "when needed" with zero interactions
+from the user.
+
+Features
+--------
+
+* no api keys or accounts needed
+* search uses file hash by default, and text as fallback
+* standalone implementation (minimal dependencies)
+* works with webtorrent
+
+Installation
+------------
+
+    $ mkdir -p ~/.config/mpv/scripts/mpvsub
+    $ git clone https://git.sinanmohd.com/mpvsub ~/.config/mpv/scripts/mpvsub
+
+Dependencies
+------------
+
+* curl
+* unzip
+
+Contact
+-------
+
+* matrix: `#chat:sinanmohd.com`
+
+you can also use email `sinan@firemail.cc` but matrix is preferred
-- 
cgit v1.2.3