Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yemi committed May 22, 2016
2 parents 533d15a + 6f7516b commit f718a4a
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# toon
# Toon

add description of toon here
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

0 comments on commit f718a4a

Please sign in to comment.