Add a cute screenshot

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 1d1ed04a2da155a3dde8283332d46fce65d169c3..2dbcd75c952effbe535d0e14140f45f63b8b12c9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,34 +3,51 @@
 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
 - [ ] Download or watch videos
 - [ ] Configuration options
 
 ## 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
 
 
 ## 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
 
 ```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
 
 ```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

 ```
 ```