X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/a000c39cc591c6bacc37ae5f4dcfc87e55e6cd5f..4827df7ac6cc2b6cbc55894f95509c2c6a26c095:/README.md

diff --git a/README.md b/README.md
index 837ace4..d0fdffa 100644
--- a/README.md
+++ b/README.md
@@ -3,38 +3,62 @@
 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
-- [ ] 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
 
-## Usage
+## Installation
+
+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
+```
 
-### As a script
 
-You must have nim installed locally for this to work.
+For other platforms, create a release artifact using the following command:
 
 ```sh
-nim c -d:ssl -r cli_tube.nim emacs
+nim c -d:ssl -d:release clitube.nim
+```
+
+Copy the binary to a directory on your PATH such as `/usr/local/bin`
+
+## Usage
+
+```sh
+clitube emacs
 
 # If your search query has multiple words, use quotes
-nim c -d:ssl -r cli_tube.nim 'nim lang'
+clitube 'nim lang'
 ```
 
-### Using the binary
+### Commandline arguments
 
-Please use the binary in the repository for now.
-Will setup GitLab CI to publish proper binaries later.
+|----------------|---------------------------|
+| ***Arguments** | **Explanation**           |
+|----------------|---------------------------|
+| -m, --music    | Play Music only, no video |
+|----------------|---------------------------|
 
-```sh
-./cli_tube emacs
+## Development
+
+One-liner for compiling and running
 
-./cli_tube 'nim lang'
+```sh
+nim c -d:ssl -r clitube.nim 'nim lang'
 ```