aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjvech <jmvalenciae@unal.edu.co>2022-01-25 10:42:22 -0500
committerjvech <jmvalenciae@unal.edu.co>2022-01-25 10:42:22 -0500
commitc3ebe7fe98668098f610b2e38461496f8987aca9 (patch)
tree9eec0e5eeb1de8f40050c8e72405cc30cf9652f7 /README.md
parent2c7d72db92a00f653b5f5db77b1ce5bc22800a07 (diff)
LICENSE and README added
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..501bc46
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# CLI-TUBE
+A simple youtube viewer, I hope you like it.
+
+## Dependencies
+```
+curl
+mpv
+yt-dlp
+```
+
+## Installation
+
+Clone the repo and go to the folder:
+```
+cd cli-tube
+sudo make install
+```
+
+If you want to uninstall it just execute
+```
+sudo make uninstall
+```
+
+## Usage
+```
+$ cli-tube <query>
+```
+
+<img src="figs/demo.gif" alt="demo" width="100%"/>
+
+
Feel free to download, copy and edit any repo