Add more items to feature list
[nimcoon.git] / README.md
CommitLineData
726cf1a7 1# CLI Tube
726cf1a7 2
44978125
JN
3Play videos from YouTube (and maybe other sources in the future) from the
4command line using your preferred desktop media player.
5
6This application is implemented in [Nim language](https://nim-lang.org).
7
8## Features
9
10- [x] Search for videos using keywords
11- [ ] Download or watch videos
12- [ ] Configuration options
a000c39c
JN
13 - [ ] Choice of video players
14 - [ ] Show video URLs or not
15 - [ ] Play audio only
16- [ ] Pagination of search results
44978125
JN
17
18## Usage
19
20### As a script
21
22You must have nim installed locally for this to work.
23
24```sh
25nim c -d:ssl -r cli_tube.nim emacs
26
27# If your search query has multiple words, use quotes
28nim c -d:ssl -r cli_tube.nim 'nim lang'
29```
30
31### Using the binary
32
33Please use the binary in the repository for now.
34Will setup GitLab CI to publish proper binaries later.
35
36```sh
37./cli_tube emacs
38
39./cli_tube 'nim lang'
40```