diff --git a/README.md b/README.md index 5c637a8..3342166 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,33 @@ -# ytdl-mpv + +
+

+ + Logo + +
+ + Lint CI + + + rofi + + + License + -Simple `rofi script` to browse and play YouTube contents using [youtube-dl](https://github.com/ytdl-org/youtube-dl/) and [mpv](https://github.com/mpv-player/mpv) +

Rofi script to browse and play YouTube contents
using youtube-dl and mpv

+

+ Features + · + Usage + · + Run +

+

## :star: Features -* Search history with local caches +* Search history and yt query cache * Customize script using available flags * Simple and intuitive rofi menu * Play video, audio @@ -16,17 +39,28 @@ Simple `rofi script` to browse and play YouTube contents using [youtube-dl](http ## :rocket: Setup -Dependencies: +**Dependencies** -* awk gzip xargs xclip -* [mpv](https://github.com/mpv-player/mpv) -* [rofi](https://github.com/davatorium/rofi) -* [youtube-dl](https://github.com/ytdl-org/youtube-dl) (always latest version) +* `awk` `nc` `sqlite3` `xargs` +* [`mpv`](https://github.com/mpv-player/mpv) +* [`rofi`](https://github.com/davatorium/rofi) +* [`youtube-dl`](https://github.com/ytdl-org/youtube-dl) (always latest version) -Simply make it `make` (ensure `~/.local/bin` is in your PATH or change PREFIX) +**Opt dependencies** + +* `xclip` for copy yt video id in clipboard + +**Install** + +Simply make it ``` git clone https://github.com/andros21/ytdl-mpv cd ytdl-mpv make ``` + +## :runner: Run + +Is advisable to key bind `ytdl-mpv`, so that rofi menu can be opened wherever you are!\ +For **debugging purposes**, instead, could be useful run `ytdl-mpv` inside a shell to view stdout/stderr