summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7737cd5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# YT Audio Player
+Command line player to listen to YT videos written in node
+Saves bandwidth and streams only the audio part of the videos
+
+# Requirements
+Node.js and npm installed
+
+# Before use
+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`