X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/763f653ff1183586ffad978b917f8deaa2d057c7..28d7042ef9a94c77a2de54902ecd46591940555e:/README.md diff --git a/README.md b/README.md index 3020333..7af3591 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,9 @@ only the standard library. - [x] Stream video and music from magnet links - [x] Download music - [x] Download video +- [x] Play playlists (MPV only) +- [ ] Download playlists +- [ ] Autoplay next video/audio - [ ] Configuration options ## Installation @@ -25,20 +28,43 @@ Nim Coon depends on the following: - mpv (recommended) or vlc - peerflix (for magnet links) -Download the latest build from GitlabCI (amd64 GNU/Linux only). +Install VLC or MPV using your distribution's package manager. + +Install YouTube-dl +``` sh +pip3 install --user youtube-dl +``` +Install PeerFlix ```sh -wget https://gitlab.com/njoseph/nimcoon/-/jobs/artifacts/master/download?job=compile -O artifacts.zip -unzip artifacts.zip +npm install --global peerflix ``` +### 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 +```