summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn Deeney <jdeeney@urx.com>2015-07-21 12:10:50 -0700
committerJohn Deeney <jdeeney@urx.com>2015-07-21 13:57:43 -0700
commit83871b252911a407db509d72f7fad9e8b6356c73 (patch)
tree107225289a7da4fa45edd9059625787fd43460c3 /README.md
parent61dbc218e747f1b550a2615ffe3065024db29239 (diff)
downloadpianobar-windows-83871b252911a407db509d72f7fad9e8b6356c73.tar.gz
pianobar-windows-83871b252911a407db509d72f7fad9e8b6356c73.tar.bz2
pianobar-windows-83871b252911a407db509d72f7fad9e8b6356c73.zip
Changed and renamed the README file to properly use Markdown.
Cleaned up and added info to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d1afcd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+#pianobar
+
+pianobar is a console client for the personalized web radio [Pandora]
+([http://www.pandora.com](http://www.pandora.com)).
+
+###Features
+
+* Play and manage (create, add more music, delete, rename, ...) your stations.
+* Rate played songs and let pandora explain why they have been selected.
+* Show upcoming songs/song history.
+* Configure keybindings.
+* last.fm scrobbling support (external application)
+* Proxy support for listeners outside the USA.
+
+###Source Code
+
+The source code can be downloaded at [github.com](http://github.com/PromyLOPh/pianobar/)
+or [6xq.net](http://6xq.net/projects/pianobar/).
+
+###Download/Installation
+
+There are community provided packages available for most Linux distributions (see your distribution’s package manager), Mac OS X ([MacPorts](http://trac.macports.org/browser/trunk/dports/audio/pianobar/Portfile) or [homebrew](http://brew.sh/)) and *BSD as well as a [native Windows port](https://github.com/thedmd/pianobar-windows).