Add instructions to README.md

2026-08-29 16:09:49 +01:00
parent c4f2c625c3
commit 6bb0221b27
1 changed files with 24 additions and 1 deletions
@@ -1,2 +1,25 @@
-# nix-helper-flake
+### nix-helper-flake

+A simple flake that provides some basic helper functions as top-level outputs.
+
+#### Usage:
+flake.nix
+```
+{
+  inputs = {
+    ...
+    
+    helpers = {
+      url = "git+https://git.greyweather.dev/greyweather/nix-helper-flake";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+}
+```
+
+Then in any module access functions with `inputs.helpers.<function-name>`, e.g.
+```
+{ inputs, config, ... }: {
+  time.timeZone = inputs.helpers.mkIfElse (config.networking.hostName == "zohran") "America/New_York" "Europe/London";
+}
+```