Update-checker v2.0 release.

Author: guttermonk

README.md

@@ -1,18 +1,8 @@
-PRs Welcome! Things left to fix:
-- [x] Improve error Handling
-- [x] Show an "updating" icon while updating
-- [x] Add notification icons
-- [x] Create a nix flake
-- [x] Failed updates populate a detailed error message in the tooltip
-- [x] Remove the additional space at the bottom of the tooltip
-- [ ] Make an optional animated spinner while updating
-- [ ] Look at the fork's way of handling the temp build using a flag vs temp dir
-- [ ] Replace ping with an offline and more private network connection checker
-- [ ] Add an optional on/off toggle
-
-
-# waybar-nixos-updates
-A Waybar update checking script for NixOS that checks for available updates and displays them in your Waybar.
+# 🔄 waybar-nixos-updates
+[![License: GPL-3.0](https://img.shields.io/badge/license-GPLv3-blue.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
+[![GitHub stars](https://img.shields.io/github/stars/guttermonk/waybar-nixos-updates?style=for-the-badge)](https://github.com/guttermonk/waybar-nixos-updates/stargazers)
+
+A [Waybar](https://github.com/Alexays/Waybar) update checking script for NixOS that checks for available updates and displays them in your Waybar.
 
 Here's how the module looks in Waybar with and without updates:
 
@@ -24,33 +14,33 @@ Here's how the module's tooltip looks when updates are available:
 
 Credit goes to [this project](https://github.com/J-Carder/waybar-apt-updates) for the idea and starting point.
 
-## Dependencies
+## 📦 Dependencies
 
 When using the flake, all dependencies are automatically handled. The script requires:
 
-### Commands/Programs:
+### 🔧 Commands/Programs:
 1. `nix` - Used for `nix flake update` and `nix build` commands
 2. `nvd` - Used for comparing system versions (`nvd diff`)
 3. `notify-send` - For desktop notifications
-4. Standard utilities: `bash`, `grep`, `awk`, `sed`, `ping`
+4. Standard utilities: `bash`, `grep`, `awk`, `sed`, `iproute2` (for `ip` command)
 
-### System Requirements:
+### 💻 System Requirements:
 1. NixOS operating system
 2. A running Waybar instance (the script outputs JSON for Waybar integration)
 3. Internet connectivity for performing update checks
 4. Desktop notification system compatible with `notify-send`
 
-### Configuration Assumptions:
+### 📋 Configuration Assumptions:
 - Your flake is in `~/.config/nixos` (configurable via Home Manager module)
 - Your flake's nixosConfigurations is named the same as your `$hostname`
 
-## How to Use
+## 🚀 How to Use
 
-### Installation Methods
+### 💿 Installation Methods
 
 This project provides multiple installation methods through its Nix flake:
 
-#### 1. Using the Flake as a Package
+#### 1. 📦 Using the Flake as a Package
 
 Add to your flake inputs:
 ```nix
@@ -64,7 +54,7 @@ Add to your flake inputs:
 }
 ```
 
-#### 2. Using Home Manager Module (Recommended)
+#### 2. 🏠 Using Home Manager Module (Recommended)
 
 This provides the most flexibility for configuration:
 
@@ -90,7 +80,7 @@ This provides the most flexibility for configuration:
 }
 ```
 
-#### 3. Using NixOS Module
+#### 3. ⚙️ Using NixOS Module
 
 For system-wide installation:
 ```nix
@@ -101,18 +91,18 @@ For system-wide installation:
 }
 ```
 
-#### 4. Using the Legacy default.nix
+#### 4. 🔄 Using the Legacy default.nix
 
 You can still use the included `default.nix` file with Home Manager:
 ```nix
 imports = [ ./path-to-waybar-nixos-updates/default.nix ];
 ```
 
-#### 5. Manual Installation
+#### 5. 🔨 Manual Installation
 
 For a manual installation, download the `update-checker` script, put it in your [PATH](https://unix.stackexchange.com/a/26059) and make it executable (`chmod +x update-checker`). Add the icons to your ~/.icons folder.
 
-### Configuration Options
+### ⚙️ Configuration Options
 You can modify these variables at the top of the script to customize behavior:
 
 - `UPDATE_INTERVAL`: Time in seconds between update checks (default: 3599)
@@ -122,7 +112,13 @@ You can modify these variables at the top of the script to customize behavior:
 - `GRACE_PERIOD`: Time in seconds to wait after boot/resume before checking (default: 60)
 - `UPDATE_LOCK_FILE`: Whether to update the lock file directly or use a temporary copy (default: false)
 
-### Waybar Integration
+### 🔄 Toggle Functionality
+The script supports toggling update checks on/off. When disabled, it will show the last known state without performing new checks:
+- To toggle: Run `update-checker toggle`
+- The toggle state is preserved across restarts
+- When disabled, the module shows "disabled" state with the last check timestamp
+
+### 🎨 Waybar Integration
 
 If you're using the Home Manager module, the waybar configuration is automatically provided through `config.programs.waybar-nixos-updates.waybarConfig`. Otherwise, configure manually:
 
@@ -133,7 +129,7 @@ In json (if adding directly to the config file):
 "custom/nix-updates": {
     "exec": "$HOME/bin/update-checker", // <--- path to script
     "signal": 12,
-    "on-click": "", // refresh on click
+    "on-click": "$HOME/bin/update-checker toggle", // toggle update checking
     "on-click-right": "rm ~/.cache/nix-update-last-run", // force an update
     "interval": 3600, // refresh every hour
     "tooltip": true,
@@ -143,6 +139,7 @@ In json (if adding directly to the config file):
         "has-updates": "󰚰", // icon when updates needed
         "updating": "", // icon when updating
         "updated": "", // icon when all packages updated
+        "disabled": "󰚰", // icon when update checking is disabled
         "error": "" // icon when errot occurs
     },
 },
@@ -153,7 +150,7 @@ In nix (if adding it "the nix way" through home-manager):
 "custom/nix-updates" = {
   exec = "$HOME/bin/update-checker";  # Or "${pkgs.waybar-nixos-updates}/bin/update-checker" if using the flake
   signal = 12;
-  on-click = "";
+  on-click = "$HOME/bin/update-checker toggle";  # Toggle update checking
   on-click-right = "rm ~/.cache/nix-update-last-run";
   interval = 3600;
   tooltip = true;
@@ -163,6 +160,7 @@ In nix (if adding it "the nix way" through home-manager):
     has-updates = "󰚰";
     updating = "";
     updated = "";
+    disabled = "󰚰";
     error = "";
   };
 };
@@ -176,7 +174,7 @@ programs.waybar.settings.mainBar."custom/nix-updates" =
 
 To style use the `#custom-nix-updates` ID in your Waybar styles file (`~/.config/waybar/styles.css`). For more information see the [Waybar wiki](https://github.com/Alexays/Waybar/wiki).
 
-### Complete Configuration Example
+### 💡 Complete Configuration Example
 
 Here's a complete example of using waybar-nixos-updates with Home Manager:
 
@@ -227,6 +225,10 @@ Here's a complete example of using waybar-nixos-updates with Home Manager:
                 #custom-nix-updates.updating {
                   color: #f9e2af;
                 }
+                #custom-nix-updates.disabled {
+                  color: #6c7086;
+                  opacity: 0.7;
+                }
                 #custom-nix-updates.error {
                   color: #eba0ac;
                 }
@@ -240,7 +242,7 @@ Here's a complete example of using waybar-nixos-updates with Home Manager:
 }
 ```
 
-### Flake Outputs
+### 📤 Flake Outputs
 
 The flake provides the following outputs:
 
@@ -249,9 +251,9 @@ The flake provides the following outputs:
 - **nixosModules.default**: NixOS module for system-level installation
 - **apps.default**: Direct execution of the update-checker script
 
-### Troubleshooting
+### 🔍 Troubleshooting
 
-#### Common Issues and Solutions
+#### 🐛 Common Issues and Solutions
 
 1. **Script not finding NixOS configuration**
    - Ensure your configuration is at `~/.config/nixos` or update the `nixosConfigPath` option
@@ -279,10 +281,10 @@ The flake provides the following outputs:
    - When using the wrapper script, restart waybar after rebuilding
    - Verify the correct script is being executed: check waybar config `exec` path
 
-### System Integration
+### ⚡ System Integration
 You can integrate the updater with your system by modifying your flake update script and your rebuild script to pass the UPDATE_FLAG variable and the REBUILD_FLAG variable, respectively.
 
-#### Your Flake Update Script and the UPDATE_FLAG
+#### 🔄 Your Flake Update Script and the UPDATE_FLAG
 You can integrate your system to control the UPDATE_FLAG, which is saved in the "nix-update-update-flag" cache file. If you have UPDATE_LOCK_FILE set to "true", no further action is required. The program will detect if your lock file has been updated. If you have UPDATE_LOCK_FILE set to "false", the "nix-update-update-flag" file will signal that your lock file has been updated.
 
 To integrate the update checker with your system, add the following to the update script you use to update your system's lock file (i.e. your "nix flake update" script), so that the output of nvd diff is piped in:
@@ -298,7 +300,7 @@ checkup =
   popd";
 ```
 
-#### Your Rebuild Script and the REBUILD_FLAG
+#### 🏗️ Your Rebuild Script and the REBUILD_FLAG
 The REBUILD_FLAG, which is saved in the "nix-update-rebuild-flag" cache file, signals this script to run after your system has been rebuilt. Add this to your update script to create the REBUILD_FLAG and send a signal to waybar to refresh after updating:
 `if [ -f \"$HOME/.cache/nix-update-update-flag\" ]; then touch \"$HOME/.cache/nix-update-rebuild-flag\" && pkill -x -RTMIN+12 .waybar-wrapped; fi &&`
 
@@ -315,10 +317,10 @@ nixup =
   popd";
 ```
 
-## Additional Information
+## ℹ️ Additional Information
 Some additional things to expect in regards to 1) what notifications you'll receive, 2) what files will be written, 3) and how the script uses your network connection.
 
-### Notifications
+### 🔔 Notifications
 These notifications require `notify-send` to be installed on your system. The script sends desktop notifications to keep you informed:
 - When starting an update check: "Checking for Updates - Please be patient"
 - When throttled due to recent checks: "Please Wait" with time until next check
@@ -327,28 +329,28 @@ These notifications require `notify-send` to be installed on your system. The sc
 - When connectivity fails: "Update Check Failed - Not connected to the internet"
 - When an update fails: "Update Check Failed - Check tooltip for detailed error message"
 
-### Cache Files
+### 💾 Cache Files
 The script uses several cache files in your ~/.cache directory:
 - `nix-update-state`: Stores the current number of available updates
 - `nix-update-last-run`: Tracks when the last update check was performed
 - `nix-update-tooltip`: Contains the tooltip text with update details
 - `nix-update-boot-marker`: Used to detect system boot/resume events
+- `nix-update-toggle`: Stores the enabled/disabled state for update checking
 - `nix-update-update-flag`: Signals that your lock file has been updated
 - `nix-update-rebuild-flag`: Signals that your system has been rebuilt
 - `nix-update-updating-flag`: Signals that an update process is currently performing
 
-### Privacy and Security Considerations
-Aside from checking repos for updates, this script uses external network requests to check for internet connectivity.
-
-In regards to external network requests, the script uses `ping -c 1 -W 2 8.8.8.8` to check network connectivity and sends packets to Google's DNS servers (8.8.8.8), which could potentially reveal:
-- That your system is running and online
-- The fact you're using this specific script
-- Your IP address to Google's DNS infrastructure
+### 🔒 Privacy and Security Considerations
+The script checks network connectivity locally using the `ip` command to verify network interfaces and routing tables. This approach:
+- Does not send any external network requests for connectivity checking
+- Only checks local network configuration (interfaces and routes)
+- Performs actual network requests only when fetching updates from configured Nix repositories
+- Provides better privacy as no external connectivity checks are performed
 
-## Contributing
+## 🤝 Contributing
 
 PRs are welcome! Please test your changes and ensure they work with both the flake installation methods and manual installation.
 
-## License
+## 📜 License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.