summaryrefslogtreecommitdiff
path: root/mpdarc-widget
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2018-11-03 10:47:23 -0400
committerGitHub <noreply@github.com>2018-11-03 10:47:23 -0400
commitdb98d2797f8ed47a4936632de0fc874691813062 (patch)
tree2ab601a1cfc335b043fc4e021370d32db891b3b4 /mpdarc-widget
parent4215fc7e92ef168c1daabc7db227c3748c1edda4 (diff)
parentd9cfaeecd3f28080d57c4e8a39035b7586346dd1 (diff)
Merge pull request #56 from hramezani/mpdarc_widget_complete_readme
Add Installation section to mpdarc-widget/README.md
Diffstat (limited to 'mpdarc-widget')
-rw-r--r--mpdarc-widget/README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/mpdarc-widget/README.md b/mpdarc-widget/README.md
index 0a6ffa6..2192410 100644
--- a/mpdarc-widget/README.md
+++ b/mpdarc-widget/README.md
@@ -10,5 +10,17 @@ Install `mpd` (Music Player Daemon itself) and `mpc` (Music Player Client - prog
sudo apt-get install mpd mpc
```
-Set them up and then just follow the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo.
+## Installation
+To use this widget clone repo under **~/.config/awesome/** and then add it in **rc.lua**:
+
+```lua
+local mpdarc_widget = require("awesome-wm-widgets.mpdarc-widget.mpdarc")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ mpdarc_widget,
+ ...
+```