aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-10-14 10:39:49 +0000
committerFuwn <[email protected]>2024-10-14 10:39:49 +0000
commit27af3b901e5b31b306bdf0f986f7445afc39b8f3 (patch)
tree4af11b75bbc6e6cfff5afaaa02dddd1666914eff
parentdocs(readme): add far too much detail to tsutsumi example (diff)
downloadyae-27af3b901e5b31b306bdf0f986f7445afc39b8f3.tar.xz
yae-27af3b901e5b31b306bdf0f986f7445afc39b8f3.zip
docs(readme): add section heading for example
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 47a0237..8e5c599 100644
--- a/README.md
+++ b/README.md
@@ -67,10 +67,12 @@ which provides both flake and flake-less installation options.
Alternatively, without flake-less support, install the
`inputs.yae.packages.${pkgs.system}.yae` package exposed by this flake.
-### Nix
+### Integrating with Nix
To add Yae support to your Nix expression after running `yae init`, just read
-from the Yae environment file.
+from the Yae environment file. See the example below for more details.
+
+### Nix Example
Here's an example snippet taken from Tsutsumi's [`zen-browser-bin` package](https://github.com/Fuwn/tsutsumi/blob/main/pkgs/zen-browser-bin.nix)
and [`yae.json`](https://github.com/Fuwn/tsutsumi/blob/main/yae.json#L59-L67)