From bd8d1c07a7a946663d63701b5896880691a993ea Mon Sep 17 00:00:00 2001 From: Seth Flynn Date: Thu, 13 Mar 2025 20:42:28 -0400 Subject: docs: add 'What is it?' section --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 6a15144..8055484 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,16 @@ Check the forecast for today's Nix builds with a blazingly fast (🚀🔥🦀) CLI +## What is it? + +`nix-forecast` helps you find out what's cached in cache.nixos.org -- or any binary cache of your choosing! + +It does this in a few different ways: + +- When an installable is passed, the configured binary caches will be checked to see if they have it +- When a system or home-manager configuration is passed, the number of it's build dependencies that are currently cached will be reported +- By default, with no arguments passed, `nix-forecast` will try it's best to calculate how much of Nixpkgs itself is cached + ## Usage ``` -- cgit v1.2.3