aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar piotrruss <mail@pruss.it> 2021-10-17 19:47:26 +0200
committerGravatar piotrruss <mail@pruss.it> 2022-02-28 20:36:12 +0000
commitcd726524db4385fb33cf3520d0e6ef6b0ac78af3 (patch)
tree2b53eb1986b34402c2a36d38398fed64a16d65d8 /README.md
downloadyt_audio_player_scrap-cd726524db4385fb33cf3520d0e6ef6b0ac78af3.tar.gz
yt_audio_player_scrap-cd726524db4385fb33cf3520d0e6ef6b0ac78af3.tar.bz2
yt_audio_player_scrap-cd726524db4385fb33cf3520d0e6ef6b0ac78af3.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..229ed81
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Youtube Audio Player
+
+Youtube audio player, great to play music in the background.
+You can also check other repo [YT_Audio_Player_API](https://git.pruss.it/yt_audio_player_api/) using official Youtube API.
+This one is scraping the website, so don't need an API key, but it could potentially break in future in case of changes on the website.
+
+![Youtube Audio Player](yt.jpg)
+
+## Usage
+
+1. Type song name and press [ENTER] to search it in YT
+2. Type result number and press [ENTER] to play the song
+3. Type a range of songs (ex. [2-5]) to play them in a row
+4. Type [r(nr)] (ex. [r2]) to find songs related to chosen result
+5. Type [h] and press [ENTER] to see this help page
+6. Type [q] and press [ENTER] to quit YT audio player
+
+## Dependencies
+
+The only dependency is a MPV player ([sources](https://mpv.io/installation/)).
+It should be available in your favourite package manager.
+