Add dependencies list

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 6c2625c82a7f8038613e40ac4ebbc3f6b99aba3e..3930178a8f6247169c57a229f11e252716b107ad 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # CLI Tube
 
-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
@@ -12,15 +12,18 @@ only the standard library.
 
 - [x] Search for videos using keywords
 - [x] Stream videos
-- [ ] Download videos
+- [x] Stream music
+- [ ] Download video
+- [ ] Download music
 - [ ] Configuration options
-    - [ ] Choice of video players
-    - [ ] Show video URLs or not
-    - [ ] Play audio only
-- [ ] Pagination of search results
+- [ ] Play magnet links
 
 ## Installation
 
+CLI Tube depends on the following:
+- youtube-dl
+- mpv (recommended) or vlc
+
 Download the latest build from GitlabCI (amd64 GNU/Linux only).
 
 ```sh
@@ -44,8 +47,18 @@ clitube emacs
 
 # If your search query has multiple words, use quotes
 clitube 'nim lang'
+
+# Advanced: Play audio of the first search result
+clitube -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 |
+
 ## Development
 
 One-liner for compiling and running