Sphinx documentation and API cleanup

[mpd-sima.git] / README

diff --git a/README b/README
index 00360ca00f39d344118935c41c497503dc7a4eed..a6bc6b0432e2cdbb62b1619cadd40c5b538ee7ed 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,15 @@
-Design for python >= 3.3
+MPD_sima Automagically add titles to MPD playlist.
+==================================================
 
-Requires: python-musicpd >= 0.4.0 [0],
-          requests >= 2.2.0 [1]
+MPD_sima_ is a non interactive MPD autoqueue client running in the background.
+It will queue new tracks chosen among artists similar to your current queued
+tracks, provided a title is found in your music library.
 
-       [0] http://media.kaliko.me/src/musicpd/
-       [1] http://docs.python-requests.org/
+Similar artists are fetched from last.fm or EchoNest webservice.
 
+MPD_sima can queue track, top track or whole album for similar artists.
 
+This client allows you to never run out of music when your queue is getting
+short.
+
+.. _MPD_sima: http://kaliko.me/code/mpd-sima/