summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJackson Taylor <jackson@jacksontaylor.xyz>2022-08-08 08:40:49 -0400
committerJackson Taylor <jackson@jacksontaylor.xyz>2022-08-08 08:40:49 -0400
commiteeabede2cdade1aaf4df809e36032b78d28fb694 (patch)
treee9b11bdcf226b95b1558cefbac811fea84fa51a2
parent930b8478d569f74f6153ac522c9bdefa450ecea7 (diff)
Update README
Add usage information Update TODOs
-rw-r--r--README.md29
1 files changed, 28 insertions, 1 deletions
diff --git a/README.md b/README.md
index 01347da..3c00cd2 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,33 @@ Personal script to when downloading music with youtube-dl, tagging the files (ar
## Installation
Right now, the easiest thing to do is just use it from this repo.
+## Usage
+Output from using the "--help" option:
+```
+usage: jamos [-h] [-c cookiefile.txt] [-o output_directory] [-r jamos_failed_urls.txt] [https://music.youtube.com/playlist?list=1234]
+
+Download songs from YouTube Music
+
+positional arguments:
+ https://music.youtube.com/playlist?list=1234
+ Playlist or Song URL to download.
+
+optional arguments:
+ -h, --help show this help message and exit
+ -c cookiefile.txt, --cookies cookiefile.txt
+ Cookie file to use.
+ -o output_directory, --output output_directory
+ Output directory to use
+ -r jamos_failed_urls.txt, --retryFile jamos_failed_urls.txt
+ Output directory to use
+
+```
+
+The most common usage (aka tldr) would probably be something like:
+```
+$ jamos "https://music.youtube.com/playlist/1234" -o "/home/jackson/Music"
+```
+
## TODO
- Installation
- Add necessary files to install via pip
@@ -13,4 +40,4 @@ Right now, the easiest thing to do is just use it from this repo.
- Configuration
- Config file in XDG directory
- URL file in XDG directory
- - Command line parameters
+ - [Done] Command line parameters