aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDemonKingSwarn <rockingswarn@gmail.com>2024-02-22 00:31:28 +0530
committerDemonKingSwarn <rockingswarn@gmail.com>2024-02-22 00:31:28 +0530
commit7e4c9465a197ed2024e85151b2b7d53d51704d1b (patch)
tree0c1de35e0a99461258f8984b8948a612c3d08dd6 /README.md
parent11cbc28bf951cd9b8788d778fdbe25d2a1f30fa7 (diff)
downloadyt-music-7e4c9465a197ed2024e85151b2b7d53d51704d1b.zip
yt-music-7e4c9465a197ed2024e85151b2b7d53d51704d1b.tar.gz
chore: config file added
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index d8ba16d..3cc76d4 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,18 @@ pip install --upgrade yt-music
**NOTE** YOU NEED TO HAVE THEM IN YOUR `PATH`
+## Config
+
+Config file has to be in the following location depending on your OS:
+
+- On Linux and Mac:
+ `$HOME/.config/yt-music/config.json`
+
+- On Windows:
+ `C:\Users\<username>\.config\yt-music\config.json`
+
+You can copy the example config `config.json.example`
+
## Usage
- Open a terminal