Add option to download video

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index e2174f3481c7cf5ffa7e2f83940fac73d5d9c8ef..4b4bb32b2330993d40dd9c49684b88e754e2430c 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.
@@ -6,7 +6,7 @@ command line using your preferred desktop media player.
 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
 
@@ -15,14 +15,13 @@ only the standard library.
 - [x] Stream music
 - [x] Play direct links from YouTube and PeerTube
 - [x] Stream video from magnet links
-- [ ] Download video
-- [ ] Download music
+- [x] Download music
+- [x] Download video
 - [ ] Configuration options
-- [ ] Play magnet links
 
 ## Installation
 
-CLI Tube depends on the following:
+Nim Coon depends on the following:
 - youtube-dl
 - mpv (recommended) or vlc
 - peerflix (for magnet links)
@@ -30,7 +29,7 @@ CLI Tube depends on the following:
 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
 ```
 
@@ -38,7 +37,7 @@ unzip artifacts.zip
 For other platforms, create a release artifact using the following command:
 
 ```sh
-nim c -d:ssl -d:release clitube.nim
+nim c -d:ssl -d:release nimcoon.nim
 ```
 
 Copy the binary to a directory on your PATH such as `/usr/local/bin`
@@ -46,26 +45,28 @@ Copy the binary to a directory on your PATH such as `/usr/local/bin`
 ## Usage
 
 ```sh
-clitube emacs
+nimcoon emacs
 
 # If your search query has multiple words, use quotes
-clitube 'nim lang'
+nimcoon 'nim lang'
 
 # Advanced: Play audio of the first search result
-clitube -m -l "counting stars"
+nimcoon -m -l "counting stars"
 ```
 
 ### Commandline arguments
 
-| **Arguments** | **Explanation**                            |
-|---------------|--------------------------------------------|
-| -m, --music   | Play Music only, no video                  |
-| -l, --lucky   | Try your luck with the first search result |
+| **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                    |
 
 ## Development
 
 One-liner for compiling and running
 
 ```sh
-nim c -d:ssl -r clitube.nim 'nim lang'
+nim c -d:ssl -r nimcoon.nim 'nim lang'
 ```