summaryrefslogtreecommitdiff
path: root/mpris-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mpris-widget/README.md')
-rw-r--r--mpris-widget/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/mpris-widget/README.md b/mpris-widget/README.md
new file mode 100644
index 0000000..317385f
--- /dev/null
+++ b/mpris-widget/README.md
@@ -0,0 +1,26 @@
+# MPRIS Widget
+
+Music Player Info widget cy @mgabs
+
+# Prerequisite
+
+Install `playerctl` (mpris implementation), should be available in repo, e.g for Ubuntu:
+
+```bash
+sudo apt-get install playerctl
+```
+
+## Installation
+
+To use this widget clone repo under **~/.config/awesome/** and then add it in **rc.lua**:
+
+```lua
+local mpris_widget = require("awesome-wm-widgets.mpris-widget")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ mpris_widget,
+ ...
+```