Make all sequences immutable

[nimcoon.git] / README.md

diff --git a/README.md b/README.md
index 302033342646f3fd1266ae3e479e7ed29ec6a5e7..296850299b870029c5a9a36de4e935dfe3517e0d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,9 +13,12 @@ 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 playlists (MPV only)
+- [ ] Download playlists
+- [ ] Autoplay next video/audio
 - [ ] Configuration options
 
 ## Installation
@@ -23,22 +26,45 @@ only the standard library.
 Nim Coon depends on the following:
 - youtube-dl
 - mpv (recommended) or vlc
-- peerflix (for magnet links)
+- peerflix and webtorrent (for magnet links)
 
-Download the latest build from GitlabCI (amd64 GNU/Linux only).
+Install MPV or VLC using your distribution's package manager.
+
+Install YouTube-dl
+``` sh
+pip3 install --user youtube-dl
+```
 
+Install PeerFlix and WebTorrent
 ```sh
-wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
-unzip artifacts.zip
+npm install --global peerflix webtorrent
 ```
 
+### Installing using Nimble
+
+NimCoon can be installed from Nimble repositories:
+
+``` sh
+nimble install nimcoon
+```
 
-For other platforms, you can install from source by running the following command:
+You can also install from source by running the following command:
 
 ```sh
 nimble install
 ```
 
+### Installing binary
+
+Download the latest build from GitlabCI (amd64 GNU/Linux only).
+
+```sh
+wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
+unzip artifacts.zip
+```
+
+Copy the binary to somewhere on your path like /usr/local/bin
+
 ## Usage
 
 ```sh
@@ -86,3 +112,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
+```