README.md

2 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
index 89445e5..8bbfc94 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,30 @@
 # jaSubs
+A "fork" of [InterSubs](https://github.com/oltodosel/interSubs), but for Japanese **only**.
+
+Interactive subtitles for mpv, that was made to help study Japanese.
+Easily tweaked and customizable.
+
+**NOTE:** This project is unstable as for now and has some bugs
+
+[](./example.gif)
+
+## Installation
+
+Clone this repository in your mpv `scripts` folder:
+```bash
+$ cd ~/.config/mpv/scripts
+$ git clone https://github.com/HasanAbbadi/jaSubs
+```
+
+Then make a symlink to the `lua` file:
+```bash
+$ pwd
+~/.config/mpv/scripts
+$ ln -s jaSubs/jaSubs.lua .
+```
+
+# Notes
+* Issues and Pull Request are highly appreciated
+
+
+
diff --git a/example.gif b/example.gif
new file mode 100644
index 0000000..4e6ff28
--- /dev/null
+++ b/example.gif