Update README before release

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 3930178a8f6247169c57a229f11e252716b107ad..302033342646f3fd1266ae3e479e7ed29ec6a5e7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# CLI Tube
+# NimCoon

 
 Play videos from YouTube and PeerTube from the
 command line using your preferred desktop media player.
 
 Play videos from YouTube and PeerTube from the
 command line using your preferred desktop media player.


@@ -6,63 +6,83 @@ command line using your preferred desktop media player.
 This application is implemented in [Nim language](https://nim-lang.org) using
 only the standard library.
 
 This application is implemented in [Nim language](https://nim-lang.org) using
 only the standard library.
 

-![clitube screenshot with search term 'baby yoda'](screenshot.png)
+![nimcoon screenshot with search term 'baby yoda'](screenshot.png)

 
 ## Features
 
 - [x] Search for videos using keywords
 
 ## Features
 
 - [x] Search for videos using keywords

-- [x] Stream videos
-- [x] Stream music
-- [ ] Download video
-- [ ] Download music
+- [x] Stream videos and music from YouTube
+- [x] Play direct links from YouTube and PeerTube
+- [x] Stream video and music from magnet links
+- [x] Download music
+- [x] Download video

 - [ ] Configuration options
 - [ ] Configuration options

-- [ ] Play magnet links

 
 ## Installation
 
 
 ## Installation
 

-CLI Tube depends on the following:
+Nim Coon depends on the following:

 - youtube-dl
 - mpv (recommended) or vlc
 - youtube-dl
 - mpv (recommended) or vlc

+- peerflix (for magnet links)

 
 Download the latest build from GitlabCI (amd64 GNU/Linux only).
 
 ```sh
 
 Download the latest build from GitlabCI (amd64 GNU/Linux only).
 
 ```sh

-wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
+wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip

 unzip artifacts.zip
 ```
 
 
 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
 
 ```sh

-nim c -d:ssl -d:release clitube.nim
+nimble install

 ```
 
 ```
 

-Copy the binary to a directory on your PATH such as `/usr/local/bin`
-

 ## Usage
 
 ```sh
 ## Usage
 
 ```sh

-clitube emacs
+nimcoon "emacs"

 
 # If your search query has multiple words, use quotes
 
 # If your search query has multiple words, use quotes

-clitube 'nim lang'
+nimcoon "nim lang"
+
+# 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

 
 

-# Advanced: Play audio of the first search result
-clitube -m -l "counting stars"
+# 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                    |

 
 

-| **Arguments** | **Explanation**                            |
-|---------------|--------------------------------------------|
-| -m, --music   | Play Music only, no video                  |
-| -l, --lucky   | Try your luck with the first search result |
+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
 
 ## Development
 
 One-liner for compiling and running
 
 ```sh

-nim c -d:ssl -r clitube.nim 'nim lang'
+nim c -d:ssl -r src/nimcoon.nim 'nim lang'

 ```
 ```