diff --git a/README.md b/README.md index 45bf057..1c83f06 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ brew install juanibiapina/tap/sub
-Nix with Flakes (binary install) +Nix with Flakes (install the `sub` binary) Add sub to your flake inputs: @@ -64,6 +64,18 @@ Then add it to your packages: ```
+
+Nix with Flakes (including setup) + +This repository is a flake that exports a function +`lib.${system}.mkSubDerivation`. This function creates a package for your cli +that uses `sub` as the entry point and already includes the [Setup](#setup). + +For an example on how to use it, check out https://github.com/ggazzi/dev-cli-utils + +Thanks [@ggazzi](https://github.com/ggazzi) for writing this module. +
+ ## Setup This section explains how to set up a CLI called `hat` using `sub`.