Use the latest build from GitlabCI

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index de431e355c077d732c3959250a14731b077a684a..fd5ec9b086c5c81fa391a8004bfb13c6f17cbbf1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,50 @@
 # CLI Tube
-Play videos from YouTube from the command line.
 
-This application is currently implemented in Nim language.
+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).
+
+## Features
+
+- [x] Search for videos using keywords
+- [ ] Download or watch videos
+- [ ] Configuration options
+    - [ ] Choice of video players
+    - [ ] Show video URLs or not
+    - [ ] Play audio only
+- [ ] Pagination of search results
+
+## Usage
+
+Download the latest build from GitlabCI
+
+```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
+
+./cli_tube 'nim lang'
+```
+
+## Development
+
+### Compiling and Running
+
+```sh
+nim c -d:ssl -r cli_tube.nim emacs
+
+# If your search query has multiple words, use quotes
+nim c -d:ssl -r cli_tube.nim 'nim lang'
+```
+
+### Creating a release artifact
+
+```sh
+nim c -d:ssl -d:release cli_tube.nim
+```
\ No newline at end of file