Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrea Rossoni committed Jul 27, 2021
1 parent a513707 commit 112a717
Showing 1 changed file with 43 additions and 9 deletions.
52 changes: 43 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
# ytdl-mpv
<!-- PROJECT LOGO -->
<br>
<p align="center">
<a href="https://github.com/andros21/ytdl-mpv">
<img src="https://user-images.githubusercontent.com/58751603/127172656-40c7adf1-b6de-4985-a1c0-14a2e58dc6f3.png" alt="Logo" width="470px">
</a>
<br>
<a href="https://github.com/andros21/ytdl-mpv/blob/master/.github/workflows/lint.yml">
<img src="https://img.shields.io/github/workflow/status/andros21/ytdl-mpv/Lint%20CI/master?label=Lint%20CI&logo=github&style=flat-square" alt="Lint CI">
</a>
<a href="https://github.com/davatorium/rofi">
<img src="https://img.shields.io/badge/rofi-interface-important?logo=youtube&style=flat-square" alt="rofi">
</a>
<a href="https://github.com/andros21/ytdl-mpv/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/andros21/ytdl-mpv?color=blue&label=License&style=flat-square" alt="License">
</a>

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)
<h4 align="center">Rofi script to browse and play YouTube contents <br>using <a href="https://github.com/ytdl-org/youtube-dl/">youtube-dl</a> and <a href="https://github.com/mpv-player/mpv">mpv</a></h4>
<p align="center">
<a href="#star-features">Features</a>
·
<a href="#rocket-setup">Usage</a>
·
<a href="#runner-run">Run</a>
</p>
</p>

## :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
Expand All @@ -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

0 comments on commit 112a717

Please sign in to comment.