added description of mpris plugin

1 files changed, 22 insertions, 0 deletions

diff --git a/README b/README
index 8dc2686..cb53ff2 100644
--- a/README
+++ b/README
@@ -115,6 +115,10 @@ Otherwise, you'll need to install them yourself.
 `with_mpd`
 :    Enables support for the [MPD] daemon. Requires the [libmpd] package.
 
+`with_mpris`
+:    Enables support for MPRIS v1/v2 protocol. 
+     Requires the [dbus-core] and [text] packages.
+
 `with_inotify`
 :    Support for inotify in modern linux kernels. This option is needed
      for the MBox and Mail plugins to work. Requires the [hinotify]
@@ -631,6 +635,24 @@ Monitors have default aliases.
                   "<composer> <title> (<album>) <track>/<plength> <statei> ",
                   "--", "-P", ">>", "-Z", "|", "-S", "><"] 10
 
+`Mpris1 PlayerName Args RefreshRate`
+- Aliases to `mpris1`
+- Requires [dbus-core] and [text] packages. 
+  To activate, pass `--flags="with_mpris"` during compilation.
+- PlayerName: player supporting MPRIS v1 protocol, in lowercase.
+- Args: default monitor arguments.
+- Variables that can be used with the `-t`/`--template` argument:
+            `album`, `artist`, `arturl`, `length`, `title`, `tracknumber`
+- Default template: `<artist> - <title>`
+- Example:
+
+         Run Mpris1 "clementine" ["-t",
+                                  "<artist> - [<tracknumber>] <title>"] 10
+
+`Mpris2 PlayerName Args RefreshRate`
+- Just like Mpris1. 
+  Supposed to be used with mediaplayers which support MPRIS v2.
+
 `Mail Args Alias`
 
 - Args: list of maildirs in form