diff --git a/README.md b/README.md index 435f3cf..e97bc83 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ -# toon +# Toon -add description of toon here \ No newline at end of file +Interactive radio station based on SoundCloud + +## Installation + +Toon uses `mpd` (music player daemon) to stream audio in a headless manner. + +```shell +$ brew tap yemi/toon +$ brew install mpd toon +``` + +## Usage + +```shell +$ mpd --no-config # runs the mpd server that toon interacts with + +$ toon +``` + +Controls (Vim style): + +`h` - previous + +`j` - pause + +`k` - play + +`l` - next + +`r` - enter track URL