Add usage in README

kachick · Jun 16, 2023 · fe6931d · fe6931d
1 parent 5b6c790
commit fe6931d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,16 @@ I have `default.nix` and `shell.nix` in many repositories. They have different n
 Personally, I use the latest [nixpkgs](https://github.com/NixOS/nixpkgs) ref.
 When I want to bump it, I always visit the nixpkgs repository and copy and paste. It is a tedious task.
 
+## Usage
+
+```console
+> go install .
+> cd repository-that-using-nix
+> $HOME/go/bin/nix-headbump && git commit -m 'Bump nixpkgs to latest' *.nix
+[main 213d1bf] Bump nixpkgs to latest
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+```
+
 ## NOTE
 
 - I guess there are many other syntax patterns in Nix files that I have not used. This code will not care about them.