Use the latest build from GitlabCI

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 1d1ed04a2da155a3dde8283332d46fce65d169c3..fd5ec9b086c5c81fa391a8004bfb13c6f17cbbf1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,27 +10,41 @@ This application is implemented in [Nim language](https://nim-lang.org).
 - [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
 
-### As a script
+Download the latest build from GitlabCI
 
-You must have nim installed locally for this to work.
+```sh
+wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
+unzip artifacts.zip
+```
+
+Run the binary
 
 ```sh
-nim c -d:ssl -r cli_tube.nim emacs
+./cli_tube emacs
 
-# If your search query has multiple words, use quotes
-nim c -d:ssl -r cli_tube.nim 'nim lang'
+./cli_tube 'nim lang'
 ```
 
-### Using the binary
+## Development
 
-Please use the binary in the repository for now.
-Will setup GitLab CI to publish proper binaries later.
+### Compiling and Running
 
 ```sh
-./cli_tube emacs
+nim c -d:ssl -r cli_tube.nim emacs
 
-./cli_tube 'nim lang'
+# 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