Skip to content

Commit bd8d1c0

Browse files
committed
docs: add 'What is it?' section
1 parent d63f119 commit bd8d1c0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Check the forecast for today's Nix builds with a blazingly fast (🚀🔥🦀) CLI
44

5+
## What is it?
6+
7+
`nix-forecast` helps you find out what's cached in cache.nixos.org -- or any binary cache of your choosing!
8+
9+
It does this in a few different ways:
10+
11+
- When an installable is passed, the configured binary caches will be checked to see if they have it
12+
- When a system or home-manager configuration is passed, the number of it's build dependencies that are currently cached will be reported
13+
- By default, with no arguments passed, `nix-forecast` will try it's best to calculate how much of Nixpkgs itself is cached
14+
515
## Usage
616

717
```

0 commit comments

Comments
 (0)