Add option to play music only

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index fd5ec9b086c5c81fa391a8004bfb13c6f17cbbf1..d0fdffa63bfbc98090146f12f50f4f55478c88f7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,48 +3,62 @@
 Play videos from YouTube (and maybe other sources in the future) from the
 command line using your preferred desktop media player.
 
 Play videos from YouTube (and maybe other sources in the future) from the
 command line using your preferred desktop media player.
 

-This application is implemented in [Nim language](https://nim-lang.org).
+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)

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

-- [ ] Download or watch videos
+- [x] Stream videos
+- [x] Stream music
+- [ ] Download videos

 - [ ] Configuration options
     - [ ] Choice of video players
     - [ ] Show video URLs or not
     - [ ] Play audio only
 - [ ] Pagination of search results
 
 - [ ] Configuration options
     - [ ] Choice of video players
     - [ ] Show video URLs or not
     - [ ] Play audio only
 - [ ] Pagination of search results
 

-## Usage
+## Installation

 
 

-Download the latest build from GitlabCI
+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
 unzip artifacts.zip
 ```
 
 
 ```sh
 wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
 unzip artifacts.zip
 ```
 

-Run the binary

 
 

-```sh
-./cli_tube emacs
+For other platforms, create a release artifact using the following command:

 
 

-./cli_tube 'nim lang'
+```sh
+nim c -d:ssl -d:release clitube.nim

 ```
 
 ```
 

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

 
 

-### Compiling and Running
+## Usage

 
 ```sh
 
 ```sh

-nim c -d:ssl -r cli_tube.nim emacs
+clitube emacs

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

-nim c -d:ssl -r cli_tube.nim 'nim lang'
+clitube 'nim lang'

 ```
 
 ```
 

-### Creating a release artifact
+### Commandline arguments
+
+|----------------|---------------------------|
+| ***Arguments** | **Explanation**           |
+|----------------|---------------------------|
+| -m, --music    | Play Music only, no video |
+|----------------|---------------------------|
+
+## Development
+
+One-liner for compiling and running

 
 ```sh
 
 ```sh

-nim c -d:ssl -d:release cli_tube.nim
-```
\ No newline at end of file
+nim c -d:ssl -r clitube.nim 'nim lang'
+```