Rename to Nim Coon

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index c0e53e4b517bb72f67c40cad7386a31929a91100..2823d1e2d1a8da0a837f7ab06186f4497ab0d626 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,31 +1,35 @@
-# CLI Tube
+# Nim Coon
 
-Play videos from YouTube (and maybe other sources in the future) from the
+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)
+![nimcoon screenshot with search term 'baby yoda'](screenshot.png)
 
 ## Features
 
 - [x] Search for videos using keywords
 - [x] Stream videos
 - [x] Stream music
-- [ ] Download videos
+- [x] Play direct links from YouTube and PeerTube
+- [x] Stream video from magnet links
+- [ ] Download video
+- [ ] Download music
 - [ ] Configuration options
-    - [ ] Choice of video players
-    - [ ] Show video URLs or not
-    - [ ] Play audio only
-- [ ] Pagination of search results
 
 ## Installation
 
+Nim Coon depends on the following:
+- youtube-dl
+- mpv (recommended) or vlc
+- peerflix (for magnet links)
+
 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
+wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
 unzip artifacts.zip
 ```
 
@@ -33,7 +37,7 @@ unzip artifacts.zip
 For other platforms, create a release artifact using the following command:
 
 ```sh
-nim c -d:ssl -d:release clitube.nim
+nim c -d:ssl -d:release nimcoon.nim
 ```
 
 Copy the binary to a directory on your PATH such as `/usr/local/bin`
@@ -41,26 +45,27 @@ Copy the binary to a directory on your PATH such as `/usr/local/bin`
 ## Usage
 
 ```sh
-clitube emacs
+nimcoon emacs
 
 # If your search query has multiple words, use quotes
-clitube 'nim lang'
+nimcoon 'nim lang'
 
 # Advanced: Play audio of the first search result
-clitube -m -l "counting stars"
+nimcoon -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 |
+| **Arguments**     | **Explanation**                            |
+|-------------------|--------------------------------------------|
+| -m, --music       | Play Music only, no video                  |
+| -l, --lucky       | Try your luck with the first search result |
+| -f, --full-screen | Play video in full screen                  |
 
 ## Development
 
 One-liner for compiling and running
 
 ```sh
-nim c -d:ssl -r clitube.nim 'nim lang'
+nim c -d:ssl -r nimcoon.nim 'nim lang'
 ```