summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSeth Flynn <[email protected]>2025-03-13 20:42:28 -0400
committerSeth Flynn <[email protected]>2025-03-13 20:42:28 -0400
commitbd8d1c07a7a946663d63701b5896880691a993ea (patch)
tree22cfee5f669c0dad3fdd70e435bafd25478a655d
parentd63f119bbdafbe332088d714ef35350ed0853388 (diff)
docs: add 'What is it?' sectionHEADv0.3.0main
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
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
```