Update README with a progress report on features

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index e4782eb49844266175f4e90dea8f4fba5d493beb..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.
 
+NewPipe app offers similar features for Android.
+
 This application is implemented in [Nim language](https://nim-lang.org) using
 only the standard library.
 
@@ -13,17 +15,44 @@ 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] 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] 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
 
+|                 | YouTube  | PeerTube (HTTP) | PeerTube (BitTorrent) | Direct Magnet Link |
+| --------        | -------- | --------        | --------              | --------           |
+| Music Streaming | ✅       | ✅              | ✅                    | ✅                 |
+| Video Streaming | ✅       | ✅              | ✅                    | ✅                 |
+| Music Download  | ✅       | ✅              |                       |                    |
+| Video Download  | ✅       | ✅              |                       |                    |
+
 ## Installation
 
 Nim Coon depends on the following:
 - youtube-dl
 - mpv (recommended) or vlc
-- peerflix (for magnet links)
+- peerflix and webtorrent (for magnet links)
+
+Install MPV or VLC using your distribution's package manager.
+
+Install YouTube-dl
+``` sh
+pip3 install --user youtube-dl
+```
+
+Install PeerFlix and WebTorrent
+```sh
+npm install --global peerflix webtorrent-cli
+```
+
+(Optional) If you want your YouTube downloads to be faster, install `aria2` download manager.
 
 ### Installing using Nimble
 
@@ -97,3 +126,22 @@ One-liner for compiling and running
 ```sh
 nim c -d:ssl -r src/nimcoon.nim 'nim lang'
 ```
+
+## Privacy
+
+To avoid storing your nimcoon searches in `zsh` history, run this command
+
+```sh
+setopt histignorespace
+```
+
+Then, add a space before typing nimcoon in the shell, like " nimcoon"
+
+```sh
+ nimcoon "this is private"
+```
+
+The same can be achieved in `bash` by setting an environment variable
+```sh
+export HISTCONTROL=ignoreboth
+```