aboutsummaryrefslogtreecommitdiff
path: root/docs/next/README.md
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-05-23 17:34:01 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-05-23 17:42:49 +0300
commitec2924d0d1f21417802c3efd0ed46b9db2c00582 (patch)
tree00432d4dbb46bb82328dfb583e36293c1603bc81 /docs/next/README.md
parent0d2c20a46235ae2535d4fdef59b9529e44faa98f (diff)
feat: add optional nix flake support
refs #208 refs #221 refs #264
Diffstat (limited to 'docs/next/README.md')
-rw-r--r--docs/next/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/next/README.md b/docs/next/README.md
index 16a9fd1c..99e99e6c 100644
--- a/docs/next/README.md
+++ b/docs/next/README.md
@@ -295,6 +295,20 @@ cargo build --release
./target/release/herdr
```
+## nix
+
+Herdr provides optional Nix flake outputs for users who already use Nix. The flake builds Herdr from source.
+
+```bash
+nix run github:ogulcancelik/herdr
+nix build github:ogulcancelik/herdr
+nix develop github:ogulcancelik/herdr
+```
+
+The flake exposes `packages.<system>.default`, `apps.<system>.default`, `devShells.<system>.default`, and `overlays.default`.
+
+Update through the same Nix workflow you used to install Herdr. For profile installs, run `nix profile list` and then `nix profile upgrade <index-or-name>`. For flake inputs, run `nix flake update herdr` in your own flake and rebuild.
+
## testing
```bash