Plan for some more features

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index ef2efcf024fca5f43e0cf0201fa4b37afa0bc905..863a48f73037f5c253154b676218c46ae8962a0f 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 video
+- [ ] Download music

 - [ ] Configuration options
 - [ ] Configuration options

-    - [ ] Choice of video players
-    - [ ] Show video URLs or not
-    - [ ] Play audio only
-- [ ] Pagination of search results
+- [ ] Play magnet links

 
 

-## 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
-./clitube emacs
+For other platforms, create a release artifact using the following command:

 
 

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

 ```
 
 ```
 

-### Creating a release artifact
+### Commandline arguments
+
+| **Arguments** | **Explanation**                            |
+|---------------|--------------------------------------------|
+| -m, --music   | Play Music only, no video                  |
+| -l, --lucky   | Try your luck with the first search result |
+
+## Development
+
+One-liner for compiling and running

 
 ```sh
 
 ```sh

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

 ```
 ```