Merge pull request #447 from radiodee1/icon-control-readme

modify readme for icon-control
streetturtle · Jun 22, 2024 · d646bb6 · d646bb6
2 parents 5e3cbf9 + 4941ac5
commit d646bb6
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/apt-widget/README.md b/apt-widget/README.md
@@ -9,6 +9,15 @@ Features:
  - update single package
  - update multiple packages
 
+## Customizations
+
+It is possible to customize widget by providing a table with the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `icon_control` | `false` | Set or unset whether _any_ click on the screen closes the dropdown after it has been opened. |
+
+
 ## Installation
 
 Clone the repo under ~/.config/awesome/ folder, then in rc.lua add the following:
@@ -25,3 +34,11 @@ s.mytasklist, -- Middle widget
 		...
 ```
 
+Or use the following.
+
+```lua
+		...
+		apt_widget({icon_control=true}),
+		...
+```
+