Update README before release 0.1.0
authorJoseph Nuthalapati <njoseph@riseup.net>
Fri, 27 Mar 2020 08:29:39 +0000 (13:59 +0530)
committerJoseph Nuthalapati <njoseph@riseup.net>
Fri, 27 Mar 2020 08:29:39 +0000 (13:59 +0530)
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
README.md

index 4b4bb32b2330993d40dd9c49684b88e754e2430c..302033342646f3fd1266ae3e479e7ed29ec6a5e7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,10 +11,9 @@ 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
+- [x] Stream video and music from magnet links
 - [x] Download music
 - [x] Download video
 - [ ] Configuration options
@@ -34,27 +33,41 @@ unzip artifacts.zip
 ```
 
 
-For other platforms, create a release artifact using the following command:
+For other platforms, you can install from source by running the following command:
 
 ```sh
-nim c -d:ssl -d:release nimcoon.nim
+nimble install
 ```
 
-Copy the binary to a directory on your PATH such as `/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**                            |
 |-------------------|--------------------------------------------|
@@ -63,10 +76,13 @@ nimcoon -m -l "counting stars"
 | -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'
 ```