Add a cute screenshot

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 837ace4fbba9bcf53c52fcd3880f2f928a466e28..2dbcd75c952effbe535d0e14140f45f63b8b12c9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,10 @@
 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
 
@@ -17,24 +20,34 @@ This application is implemented in [Nim language](https://nim-lang.org).
 
 ## 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
+./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
+## 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 clitube.nim emacs
 
-./cli_tube 'nim lang'
+# If your search query has multiple words, use quotes
+nim c -d:ssl -r clitube.nim 'nim lang'
+```
+
+### Creating a release artifact
+
+```sh
+nim c -d:ssl -d:release clitube.nim
 ```