diff options
| author | streetturtle <streetturtle@gmail.com> | 2020-08-17 17:00:55 -0400 |
|---|---|---|
| committer | streetturtle <streetturtle@gmail.com> | 2020-08-17 17:00:55 -0400 |
| commit | 3b68a403c7d79dd88be01c3d8e30b98dabc353d8 (patch) | |
| tree | ade7620688ca5233011d1c73decd5492e6b4730a /docker-widget/README.md | |
| parent | 0973c7586ec0db7e6ec51297d7e38c4ee915b472 (diff) | |
[docker] update readme
Diffstat (limited to 'docker-widget/README.md')
| -rw-r--r-- | docker-widget/README.md | 32 |
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: + + + +## 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 |