README.md

   1 # CLI Tube
   2
   3 Play videos from YouTube (and maybe other sources in the future) from the
   4 command line using your preferred desktop media player.
   5
   6 This 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
  13
  14 ## Usage
  15
  16 ### As a script
  17
  18 You must have nim installed locally for this to work.
  19
  20 ```sh
  21 nim c -d:ssl -r cli_tube.nim emacs
  22
  23 # If your search query has multiple words, use quotes
  24 nim c -d:ssl -r cli_tube.nim 'nim lang'
  25 ```
  26
  27 ### Using the binary
  28
  29 Please use the binary in the repository for now.
  30 Will setup GitLab CI to publish proper binaries later.
  31
  32 ```sh
  33 ./cli_tube emacs
  34
  35 ./cli_tube 'nim lang'
  36 ```