Merge pull request #388 from jarrowsm/pacman-widget

pacman-widget

1 files changed, 37 insertions, 0 deletions

diff --git a/pacman-widget/README.md b/pacman-widget/README.md
new file mode 100644
index 0000000..f9c4325
--- /dev/null
+++ b/pacman-widget/README.md
@@ -0,0 +1,37 @@
+# Pacman widget for AwesomeWM
+
+This widget displays the number of upgradable Pacman packages. Clicking the icon reveals a scrollable list of available upgrades. A full system upgrade can be performed from the widget via Polkit.
+
+![](screenshots/pacman.gif)
+
+## Requirements
+`lxpolkit` is the default [Polkit agent](https://wiki.archlinux.org/title/Polkit).
+
+The widget also uses the `checkupdates` script from the `pacman-contrib` package.
+
+
+## Installation
+
+Clone the repo under **~/.config/awesome/** and add the following to **rc.lua**:
+
+```lua
+local pacman_widget = require('pacman-widget.pacman')
+...
+s.mytasklist, -- Middle widget
+	{ -- Right widgets
+    	layout = wibox.layout.fixed.horizontal,
+        ...
+        -- default
+        pacman_widget(),
+        -- custom (shown with defaults)
+        pacman_widget {
+            interval = 600,	-- Refresh every 10 minutes
+            popup_bg_color = '#222222',
+            popup_border_width = 1,
+            popup_border_color = '#7e7e7e',
+            popup_height = 10,	-- 10 packages shown in scrollable window
+            popup_width = 300,
+            polkit_agent_path = '/usr/bin/lxpolkit'
+        },
+```
+