awesome: add awesompd widget + mpd bindings

[dotfiles.git] / awesome / widgets / awesompd / README.md

diff --git a/awesome/widgets/awesompd/README.md b/awesome/widgets/awesompd/README.md
new file mode 100644 (file)
index 0000000..7a73137
--- /dev/null
+++ b/awesome/widgets/awesompd/README.md
@@ -0,0 +1,24 @@
+## Description ##
+
+This is an advanced MPD widget\client for AwesomeWM.
+
+For the detailed installation guide please see
+http://awesome.naquadah.org/wiki/Awesompd_widget .
+
+Also you can find an example of the widget configuration in the file
+rcsample.lua.
+
+## Version explanation ##
+
+Use this version with Awesome v3.5.x. If you are using Awesome
+v.3.4.x, please consider using
+[this](https://github.com/alexander-yakushev/awesompd/tree/awesome-3.4)
+version of the widget.
+
+### Changes in 1.1.0 ###
+
+* Album covers are now also shown for the local tracks (images are taken from the current track's folder)
+* When the Jamendo track is playing you can visit artist's or album's page from the Jamendo menu
+* Notification now shows the album name for the current track (for both local and Jamendo tracks)
+* A few minor modifications and bugfixes
+