X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/726cf1a72986f856629f70a59990e15589ff2780..7d08d1af09a1a9d6ee71c88442580e428f125508:/README.md

diff --git a/README.md b/README.md
index de431e3..3930178 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,68 @@
 # CLI Tube
-Play videos from YouTube from the command line.
 
-This application is currently implemented in Nim language.
+Play videos from YouTube and PeerTube from the
+command line using your preferred desktop media player.
+
+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
+- [x] Stream videos
+- [x] Stream music
+- [ ] Download video
+- [ ] Download music
+- [ ] Configuration options
+- [ ] Play magnet links
+
+## Installation
+
+CLI Tube depends on the following:
+- youtube-dl
+- mpv (recommended) or vlc
+
+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
+```
+
+
+For other platforms, create a release artifact using the following command:
+
+```sh
+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
+clitube 'nim lang'
+
+# Advanced: Play audio of the first search result
+clitube -m -l "counting stars"
+```
+
+### Commandline arguments
+
+| **Arguments** | **Explanation**                            |
+|---------------|--------------------------------------------|
+| -m, --music   | Play Music only, no video                  |
+| -l, --lucky   | Try your luck with the first search result |
+
+## Development
+
+One-liner for compiling and running
+
+```sh
+nim c -d:ssl -r clitube.nim 'nim lang'
+```