Improve instructions in README

Signed-off-by: Joseph Nuthalapati's avatarJoseph Nuthalapati <[email protected]>
parent a6c167a7
Pipeline #99774902 passed with stage
in 53 seconds
......@@ -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'
```
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment