diff --git a/README.md b/README.md index fbae55b..2ec637d 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ This small Python script and .desktop file add a quick toggle to the desktop environment's system tray. +![NextDNS Tray demo](nextdns_tray_demo.png "NextDNS Tray demo") + ## Prerequisites 1. **NextDNS CLI**: The script controls the nextdns service. If you haven't installed it yet: @@ -11,7 +13,7 @@ environment's system tray. sh -c 'curl -sL https://nextdns.io/install | sh' ``` -1. **Python 3 & PyQt6**: The interface is built using Python 3 and the Qt6 +2. **Python 3 & PyQt6**: The interface is built using Python 3 and the Qt6 toolkit. (This is installed by default on (K)ubuntu.) ```bash @@ -19,7 +21,7 @@ sudo apt update sudo apt install python3 python3-pyqt6 ``` -1. **Polkit Agent**: The script uses pkexec to handle start/stop commands safely. Most desktop environments (KDE, GNOME, XFCE) come with this pre-installed. +3. **Polkit Agent**: The script uses pkexec to handle start/stop commands safely. Most desktop environments (KDE, GNOME, XFCE) come with this pre-installed. ## Installation @@ -34,13 +36,13 @@ cp home/.local/share/applications/nextdns-tray.desktop ~/.local/share/applicatio cp home/.local/share/icons/nextdns.png ~/.local/share/icons/ ``` -1. **Make the script executable** +2. **Make the script executable** ```bash chmod +x ~/.local/bin/nextdns-tray ``` -1. **(Optional) Add to Autostart**: If you want the tray to start automatically when you log in: +3. **(Optional) Add to Autostart**: If you want the tray to start automatically when you log in: ```bash mkdir -p ~/.config/autostart diff --git a/nextdns_tray_demo.png b/nextdns_tray_demo.png new file mode 100644 index 0000000..83072c3 Binary files /dev/null and b/nextdns_tray_demo.png differ