X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/88a5646a568ba5aca9b26bb8423fd9756f6831ca..55b0cae73065832a9bce15e7921822fa4172684e:/README.md diff --git a/README.md b/README.md index a852de6..ddba7a1 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,15 @@ 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 +- [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 - [ ] Configuration options ## Installation @@ -23,18 +29,18 @@ 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) -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 ``` ### Installing using Nimble @@ -109,3 +115,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 +```