diff --git a/nix-monitor/README.md b/nix-monitor/README.md index 95f9bde..cef9773 100644 --- a/nix-monitor/README.md +++ b/nix-monitor/README.md @@ -1,5 +1,17 @@ # Nix Monitor -![thumbnail](thumbnail.webp) +![Nix Monitor thumbnail](thumbnail.webp) -**Nix Monitor** checks Nixpkgs update by comparing local nix hash and remote Nixpkgs's hash. It also can run update and clean command. +**Nix Monitor** checks Nixpkgs update by comparing local nix hash and remote Nixpkgs's hash + +## Features + - Shows local and remote nixpkgs hash + - Shows NixOS and optionally Home Manager generations + - Shows Nix Store size and closure size + - Customizable clean and update command + + ## Requirements + - Git + - NixOS commands (`nix`, `nixos-rebuild`, `nixos-version`) + - Linux tools (`du`, `cat`, `awk`, `grep`, `tail`, `wc`, `pkill`) + - Optionally `home-manager`