X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/f7735b43cbeb05c3e30cc9d2d0df3197fa1c0eb9..201100de47bd2baf6d0199fd82f87d83257768d1:/README.md

diff --git a/README.md b/README.md
index daf4ca6..a852de6 100644
--- a/README.md
+++ b/README.md
@@ -11,12 +11,11 @@ only the standard library.
 ## Features
 
 - [x] Search for videos using keywords
-- [x] Stream videos
-- [x] Stream music
+- [x] Stream videos and music from YouTube
 - [x] Play direct links from YouTube and PeerTube
-- [x] Stream video from magnet links
-- [ ] Download video
-- [ ] Download music
+- [x] Stream video and music from magnet links
+- [x] Download music
+- [x] Download video
 - [ ] Configuration options
 
 ## Installation
@@ -26,46 +25,87 @@ Nim Coon depends on the following:
 - mpv (recommended) or vlc
 - peerflix (for magnet links)
 
-Download the latest build from GitlabCI (amd64 GNU/Linux only).
+Install VLC or MPV using your distribution's package manager.
+
+Install YouTube-dl
+``` sh
+pip3 install --user youtube-dl
+```
 
+Install PeerFlix
 ```sh
-wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
-unzip artifacts.zip
+npm install --global peerflix
+```
+
+### Installing using Nimble
+
+NimCoon can be installed from Nimble repositories:
+
+``` sh
+nimble install nimcoon
+```
+
+You can also install from source by running the following command:
+
+```sh
+nimble install
 ```
 
+### Installing binary
 
-For other platforms, create a release artifact using the following command:
+Download the latest build from GitlabCI (amd64 GNU/Linux only).
 
 ```sh
-nim c -d:ssl -d:release nimcoon.nim
+wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
+unzip artifacts.zip
 ```
 
-Copy the binary to a directory on your PATH such as `/usr/local/bin`
+Copy the binary to somewhere on your path like /usr/local/bin
 
 ## Usage
 
 ```sh
-nimcoon emacs
+nimcoon "emacs"
 
 # If your search query has multiple words, use quotes
-nimcoon 'nim lang'
+nimcoon "nim lang"
 
-# Advanced: Play audio of the first search result
+# Play audio of the first search result
 nimcoon -m -l "counting stars"
+
+# Download audio of the first search result
+nimcoon -mld "counting stars"
+
+# Play direct video link
+nimcoon https://www.youtube.com/watch?v=QOEMv0S8AcA
+
+# Add -d to download or -m to select only audio or both
+nimcoon -md https://www.youtube.com/watch?v=hT_nvWreIhg
 ```
 
-### Commandline arguments
+After the search results are displayed, you can enter a number to play one
+result, "all" to play all the results or "q" to quit the program. 
+
+If a number is entered, after the selected search result is played, the results
+are redisplayed, so that you can play the other results without having to search
+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                    |
+
+Feel free to use these options in any combination. NimCoon will show a helpful
+error message if you pick incompatible options.
 
 ## Development
 
 One-liner for compiling and running
 
 ```sh
-nim c -d:ssl -r nimcoon.nim 'nim lang'
+nim c -d:ssl -r src/nimcoon.nim 'nim lang'
 ```