README: Add comprehensive feature list

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index ddba7a1a3a7aa10853ef6c3b8e667b29f3a0442d..8d38083803f4a2cb925a6f6405a00af2c380f832 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
 Play videos from YouTube and PeerTube from the
 command line using your preferred desktop media player.
 
 Play videos from YouTube and PeerTube from the
 command line using your preferred desktop media player.
 

+NewPipe app offers similar features for Android.
+

 This application is implemented in [Nim language](https://nim-lang.org) using
 only the standard library.
 
 This application is implemented in [Nim language](https://nim-lang.org) using
 only the standard library.
 


@@ -16,14 +18,29 @@ only the standard library.
 - [x] Stream video and music from magnet links and hyperlinks to torrent files
 - [x] Download music
 - [x] Download video
 - [x] Stream video and music from magnet links and hyperlinks to torrent files
 - [x] Download music
 - [x] Download video

-- [x] Play playlists (MPV only)
-- [ ] Download playlists
+- [x] Play YouTube playlists (MPV only)
+- [ ] Download YouTube playlists

 - [x] Stream video from torrent file URLs
 - [x] BitTorrent is preferred for PeerTube video links
 - [ ] Search PeerTube (3.0 or later)
 - [x] Stream video from torrent file URLs
 - [x] BitTorrent is preferred for PeerTube video links
 - [ ] Search PeerTube (3.0 or later)

-- [ ] Autoplay next video/audio
+- [ ] YouTube Autoplay

 - [ ] Configuration options
 
 - [ ] Configuration options
 

+|                         | YouTube  | PeerTube (HTTP) | PeerTube (WebTorrent) |
+| --------                | -------- | --------        | --------              |
+| Music Streaming         | ✅       | ✅              | ✅                    |
+| Video Streaming         | ✅       | ✅              | ✅                    |
+| Music Download          | ✅       | ✅              |                       |
+| Video Download          | ✅       | ✅              |                       |
+| Stream Music from URL   | ✅       | ✅              |                       |
+| Stream Video from URL   | ✅       | ✅              | ✅                    |
+| Download Music from URL | ✅       | ✅              |                       |
+| Download Video from URL | ✅       | ✅              |                       |
+| Stream Music Playlist   | ✅       |                 |                       |
+| Stream Video Playlist   | ✅       |                 |                       |
+| Download Music Playlist |          |                 |                       |
+| Download Video Playlist |          |                 |                       |
+

 ## Installation
 
 Nim Coon depends on the following:
 ## Installation
 
 Nim Coon depends on the following:


@@ -40,9 +57,11 @@ pip3 install --user youtube-dl
 
 Install PeerFlix and WebTorrent
 ```sh
 
 Install PeerFlix and WebTorrent
 ```sh

-npm install --global peerflix webtorrent
+npm install --global peerflix webtorrent-cli

 ```
 
 ```
 

+(Optional) If you want your YouTube downloads to be faster, install `aria2` download manager.
+

 ### Installing using Nimble
 
 NimCoon can be installed from Nimble repositories:
 ### Installing using Nimble
 
 NimCoon can be installed from Nimble repositories: