Update README with a progress report on features

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 75adeaa3a7d9a85706a76175093e17a5d7e846c0..18453ab7c9446b415656aeebda4156dd345a4f21 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.
 


@@ -13,14 +15,24 @@ only the standard library.
 - [x] Search for videos using keywords
 - [x] Stream videos and music from YouTube
 - [x] Play direct links from YouTube and PeerTube
 - [x] Search for videos using keywords
 - [x] Stream videos and music from YouTube
 - [x] Play direct links from YouTube and PeerTube

-- [x] Stream video and music from magnet links
+- [x] Stream video and music from magnet links and hyperlinks to torrent files

 - [x] Download music
 - [x] Download video
 - [x] Download music
 - [x] Download video

-- [x] Play playlists (MPV only)
-- [ ] Download playlists
-- [ ] Autoplay next video/audio
+- [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)
+- [ ] YouTube Autoplay

 - [ ] Configuration options
 
 - [ ] Configuration options
 

+|                 | YouTube  | PeerTube (HTTP) | PeerTube (BitTorrent) | Direct Magnet Link |
+| --------        | -------- | --------        | --------              | --------           |
+| Music Streaming | ✅       | ✅              | ✅                    | ✅                 |
+| Video Streaming | ✅       | ✅              | ✅                    | ✅                 |
+| Music Download  | ✅       | ✅              |                       |                    |
+| Video Download  | ✅       | ✅              |                       |                    |
+

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


@@ -37,9 +49,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: