update TODO list

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 03666ee1d704807a19f8fdb771c5f15b81320242..6e88ecf972410eef8e0830bee86a7dc794e14432 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# NimCoon
+# Nimcoon
 
 Play videos from YouTube and PeerTube from the command line using your preferred desktop media player.
 
@@ -28,7 +28,7 @@ I tried all kinds of alternative YouTube players for the desktop. Most are eithe
 
 YouTube's business incentive is to make you watch as many videos as possible. If you open the YouTube website and are logged into it, you will just get distracted by recommendations and forget why you opened it in the first place. You might have wanted to watch a conference talk but end up going down a rabbit hole of other "interesting" videos customized for you. 
 
-NimCoon has a spartan design. It doesn't even show images of the search results. It doesn't let you browse YouTube. You have to explicitly search for something.
+Nimcoon has a spartan design. It doesn't even show images of the search results. It doesn't let you browse YouTube. You have to explicitly search for something.
 
 I have had better success with managing my YouTube consumption after shifting to this tool. Settings inspired by Pinafore's wellness settings.
 
@@ -49,7 +49,7 @@ I made this just for myself. The development is completely based on my needs and
 - [x] Stream video from torrent file URLs
 - [x] BitTorrent is preferred for PeerTube video links
 - [ ] Search PeerTube (3.0 or later)
-- [ ] YouTube Autoplay (music only)
+- [x] YouTube Autoplay (music only)
 - [ ] Configuration options
 
 |                         | YouTube  | PeerTube (HTTP) | PeerTube (WebTorrent) |
@@ -66,31 +66,32 @@ I made this just for myself. The development is completely based on my needs and
 | Stream Video Playlist   | ✅       |                 |                       |
 | Download Music Playlist |          |                 |                       |
 | Download Video Playlist |          |                 |                       |
+| Play Recommended Music  | ✅       |                 |                       |
 
 ## Installation
 
 Nim Coon depends on the following:
-- youtube-dl
+- yt-dlp
 - mpv (recommended) or vlc
-- peerflix and webtorrent (for magnet links)
+- webtorrent (for magnet links)
 
 Install MPV or VLC using your distribution's package manager.
 
-Install YouTube-dl
+Install yt-dlp
 ``` sh
-pip3 install --user youtube-dl
+pip3 install --user yt-dlp
 ```
 
-Install PeerFlix and WebTorrent
+Install WebTorrent
 ```sh
-npm install --global peerflix webtorrent-cli
+npm install --global webtorrent-cli
 ```
 
 (Optional) If you want your YouTube downloads to be faster, install `aria2` download manager.
 
 ### Installing using Nimble
 
-NimCoon can be installed from Nimble repositories:
+Nimcoon can be installed from Nimble repositories:
 
 ``` sh
 nimble install nimcoon
@@ -143,16 +144,43 @@ 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.
 
-Feel free to use these options in any combination. NimCoon will show a helpful
+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                    |
+| -a, --auto-play               | Play the next search result (YouTube only) |
+
+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                    |
+| -a, --auto-play           | Play the next search result (YouTube only) |
+
+Auto-playing videos leads to binge watching. The default option in Nimcoon is to
+support auto-play for music only.
+
 ## Development
 
 One-liner for compiling and running