From: Joseph Nuthalapati <njoseph@riseup.net>
Date: Sun, 1 Dec 2019 14:13:45 +0000 (+0530)
Subject: Improve instructions in README
X-Git-Tag: 0.1.0~52
X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/commitdiff_plain/3f6de5cb78a90bc516ff0eb63a0ea6beaa1e09d7?hp=a6c167a7715590cc60cc71f86c0f6c0fa639fee9

Improve instructions in README

Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
---

diff --git a/README.md b/README.md
index 2dbcd75..6c2625c 100644
--- a/README.md
+++ b/README.md
@@ -11,43 +11,45 @@ only the standard library.
 ## Features
 
 - [x] Search for videos using keywords
-- [ ] Download or watch videos
+- [x] Stream videos
+- [ ] Download videos
 - [ ] Configuration options
     - [ ] Choice of video players
     - [ ] Show video URLs or not
     - [ ] Play audio only
 - [ ] Pagination of search results
 
-## Usage
+## Installation
 
-Download the latest build from GitlabCI
+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
 ```
 
-Run the binary
 
-```sh
-./clitube emacs
+For other platforms, create a release artifact using the following command:
 
-./clitube 'nim lang'
+```sh
+nim c -d:ssl -d:release clitube.nim
 ```
 
-## Development
+Copy the binary to a directory on your PATH such as `/usr/local/bin`
 
-### Compiling and Running
+## Usage
 
 ```sh
-nim c -d:ssl -r clitube.nim emacs
+clitube emacs
 
 # If your search query has multiple words, use quotes
-nim c -d:ssl -r clitube.nim 'nim lang'
+clitube 'nim lang'
 ```
 
-### Creating a release artifact
+## Development
+
+One-liner for compiling and running
 
 ```sh
-nim c -d:ssl -d:release clitube.nim
+nim c -d:ssl -r clitube.nim 'nim lang'
 ```