summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 46ae690..7d0319f 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
Command line player to listen to YT videos written in node
Saves bandwidth and streams only the audio part of the videos
+![image](https://user-images.githubusercontent.com/36819371/120231736-568b2b00-c252-11eb-8711-0d586f5d61ab.png)
+
# Requirements
1. Node.js and npm
2. mpv
@@ -11,3 +13,11 @@ Saves bandwidth and streams only the audio part of the videos
1. Install node packages with `npm i`
2. Copy `config.example` as `example` and put your YT API key inside.
3. Run it with `./yta`
+
+# 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 help page
+6. Type `q` and press `ENTER` to quit YT audio player