summaryrefslogtreecommitdiff
path: root/docker-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docker-widget/README.md')
-rw-r--r--docker-widget/README.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/docker-widget/README.md b/docker-widget/README.md
index ae0615e..105a0ed 100644
--- a/docker-widget/README.md
+++ b/docker-widget/README.md
@@ -1,3 +1,33 @@
# Docker Widget
-The widget is in progress... \ No newline at end of file
+The widget allows to manage containers, namely start/stop/pause/unpause:
+
+![screenshot](./docker.gif)
+
+## Customization
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `icon` | `./docker-widget/icons/docker.svg` | Path to the icon |
+| `number_of_containers` | `-1` | Number of last created containers to show |
+
+## Installation
+
+Clone the repo under **~/.config/awesome/** and add widget in **rc.lua**:
+
+```lua
+local docker_widget = require("awesome-wm-widgets.docker-widget.docker")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ -- default
+ docker_widget(),
+ -- customized
+ github_activity_widget{
+ number_of_containers = 5
+ },
+``` \ No newline at end of file