From eeabede2cdade1aaf4df809e36032b78d28fb694 Mon Sep 17 00:00:00 2001
From: Jackson Taylor <jackson@jacksontaylor.xyz>
Date: Mon, 8 Aug 2022 08:40:49 -0400
Subject: Update README

Add usage information
Update TODOs
---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

(limited to 'README.md')

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
-- 
cgit v1.2.3