]> njoseph.me Git - nimcoon.git/blobdiff - README.md
Add interactive arguments to override global ones
[nimcoon.git] / README.md
index 03666ee1d704807a19f8fdb771c5f15b81320242..7de80d0e0922d54ce141d88157f8b4c34871d322 100644 (file)
--- a/README.md
+++ b/README.md
@@ -143,16 +143,38 @@ again.
 
 ### Command line arguments
 
-| **Arguments**     | **Explanation**                            |
-|-------------------|--------------------------------------------|
-| -m, --music       | Play Music only, no video                  |
-| -l, --lucky       | Try your luck with the first search result |
-| -f, --full-screen | Play video in full screen                  |
-| -d, --download    | Download video or music                    |
+NimCoon provides both interactive and non-interactive arguments with significant
+overlap. But some arguments might only be present in one mode.
+
+Non-interactive arguments are specified to the nimcoon program and apply
+globally to all search results in that session. These can be overriden on a
+case-by-case basis using the interactive arguments.
+
+| **Non-interactive Arguments** | **Explanation**                            |
+|-------------------------------|--------------------------------------------|
+| -m, --music                   | Play Music only, no video                  |
+| -l, --lucky                   | Try your luck with the first search result |
+| -f, --full-screen             | Play video in full screen                  |
+| -d, --download                | Download video or music                    |
 
 Feel free to use these options in any combination. NimCoon will show a helpful
 error message if you pick incompatible options.
 
+Interactive arguments are provided during selection of a search result. These
+options allow you to change your mind after performing the search. For example,
+you might have searched for a music video, watched it and want to download the
+music only. In this case, you can specify the search result followed by the
+options as single characters. i.e
+
+"1" plays the video
+"1 md" downloads the music of the video
+
+| **Interactive Arguments** | **Explanation**           |
+|---------------------------|---------------------------|
+| -m, --music               | Play Music only, no video |
+| -f, --full-screen         | Play video in full screen |
+| -d, --download            | Download video or music   |
+
 ## Development
 
 One-liner for compiling and running