X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/88a5646a568ba5aca9b26bb8423fd9756f6831ca..dfe4f8113315c1c614e596721e1f972a3266c54b:/README.md

diff --git a/README.md b/README.md
index a852de6..8d38083 100644
--- 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,30 +15,53 @@ 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 (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:
 - youtube-dl
 - mpv (recommended) or vlc
-- peerflix (for magnet links)
+- peerflix and webtorrent (for magnet links)
 
-Install VLC or MPV using your distribution's package manager.
+Install MPV or VLC using your distribution's package manager.
 
 Install YouTube-dl
 ``` sh
 pip3 install --user youtube-dl
 ```
 
-Install PeerFlix
+Install PeerFlix and WebTorrent
 ```sh
-npm install --global peerflix
+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:
@@ -109,3 +134,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
+```