README: Add section on Motivation
authorJoseph Nuthalapati <njoseph@riseup.net>
Sat, 20 Jun 2020 10:13:46 +0000 (15:43 +0530)
committerJoseph Nuthalapati <njoseph@riseup.net>
Sat, 20 Jun 2020 10:13:46 +0000 (15:43 +0530)
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
README.md

index 8d38083803f4a2cb925a6f6405a00af2c380f832..a8791803b4266ad633996ae632eec8d5e99fd0fd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,13 +3,29 @@
 Play videos from YouTube and PeerTube from the
 command line using your preferred desktop media player.
 
-NewPipe app offers similar features for Android.
+NewPipe app for Android offers similar features.
 
 This application is implemented in [Nim language](https://nim-lang.org) using
 only the standard library.
 
 ![nimcoon screenshot with search term 'baby yoda'](screenshot.png)
 
+## Motivation
+
+### No similar existing tool
+
+I tried all kinds of alternative YouTube players for the desktop. Most are either electron apps or slow web proxies. There was one cool bash script that did most of what I wanted called `ytview` but it had no way of copying the URL. I added this feature to the bash script but was still unsatisfied. There were CLI players written in Python but are usually a pain to install. They depend on a hard-coded YouTube API token and suffer from rate-limiting. I use youtube-dl with mpv usually (mostly because I like MPV over the YouTube JavaScript player). These tools have hundreds of options and I can't remember them. I needed a wrapper for them that does what I want, is easy to install(portable) and has a simple interface. I am not a big fan of Golang and its fat binaries. I discovered Nim around the same time I had this problem and decided to write this tool using just the standard library.
+
+### Digital Minimalism
+
+YouTube's business incentive is to make you watch as many videos as possible. If you open the YouTube website and are logged into it, you will just get distracted by recommendations and forget why you opened it in the first place. You might have wanted to watch a conference talk but end up going down a rabbit hole of other "interesting" videos customized for you. 
+
+NimCoon has a spartan design. It doesn't even show images of the search results. I have had better success with managing my YouTube consumption after shifting to this tool. Pinafore's wellness settings are an inspiration for this.
+
+### Why no issues or merge requests?
+
+I made this just for myself. The development is completely based on my needs and wants. I am not going to put a lot of work into this project. But feel free to use it if it works for you.
+
 ## Features
 
 - [x] Search for videos using keywords
@@ -23,7 +39,7 @@ only the standard library.
 - [x] Stream video from torrent file URLs
 - [x] BitTorrent is preferred for PeerTube video links
 - [ ] Search PeerTube (3.0 or later)
-- [ ] YouTube Autoplay
+- [ ] YouTube Autoplay (music only)
 - [ ] Configuration options
 
 |                         | YouTube  | PeerTube (HTTP) | PeerTube (WebTorrent) |
@@ -153,3 +169,4 @@ The same can be achieved in `bash` by setting an environment variable
 ```sh
 export HISTCONTROL=ignoreboth
 ```
+