From 2a03ba3075dcfe1d02f48d51e88d6c75cc6258ea Mon Sep 17 00:00:00 2001 From: Neil Bird Date: Thu, 11 Mar 2021 16:44:51 +0000 Subject: [PATCH] Link to GNOME Extensions website, and add legend for the icons --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5f463c8..92373f4 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ GNOME Shell extension to report Pi-Hole status. Licensed under the GPL V3. ### Installation +#### The easy way + +Install it from the [GNOME Extensions website](https://extensions.gnome.org/extension/4051/pi-hole/). + +#### The difficult way + Download the ZIP file (from the link above), and then install it from the GNOME *Advanced Settings* application's “Shell Extensions/Install Shell Extension” function. @@ -20,8 +26,14 @@ enable the extension via the **advanced-settings** GUI. ### Main functionality This extension polls your Pi-Hole server periodically (every 20 seconds by -default), and shows the current status via its icon. Its menu allows you -to temporarily pause (default for 20 seconds), disable or enable the Pi-Hole. +default), and shows the current status via its icon: +| Icon | Meaning | +| --- | --- | +| ![enabled](https://github.com/fnxweb/gnome-shell-pi-hole/raw/master/pi-hole%40fnxweb.com/icons/pi-hole-symbolic.svg) | Enabled | +| ![enabled](https://github.com/fnxweb/gnome-shell-pi-hole/raw/master/pi-hole%40fnxweb.com/icons/pi-hole-disabled-symbolic.svg) | Disabled | +| ![enabled](https://github.com/fnxweb/gnome-shell-pi-hole/raw/master/pi-hole%40fnxweb.com/icons/pi-hole-unknown-symbolic.svg) | Unknown / error | + +Its menu allows you to temporarily pause (default for 20 seconds), disable or enable the Pi-Hole. ![Screenshot](https://github.com/fnxweb/gnome-shell-pi-hole/raw/master/images/main-menu.png)