From 0d6bf8551998d60969bf042ca7cc4a2c9be54697 Mon Sep 17 00:00:00 2001
From: Kristian Krsnik <git@krsnik.at>
Date: Wed, 4 Oct 2023 19:11:32 +0200
Subject: [PATCH] removed default from nix and added an example instead

---
 nix/module.nix | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/nix/module.nix b/nix/module.nix
index 0caeb1b..e33c01d 100644
--- a/nix/module.nix
+++ b/nix/module.nix
@@ -23,11 +23,16 @@ in {
     settings = mkOption {
       type = with types; attrsOf (either str int);
 
-      default = {
-        logFile = throw "Please specify outage-detector.settings.";
-        host = "1.1.1.1";
-        timeout = 2;
-      };
+      description = lib.mdDoc ''
+        The settings for the outage-detector script.
+
+        Example:
+        {
+          logFile = /home/user/outage-detector.log;";
+          host = "1.1.1.1";
+          timeout = 2;
+        };
+      '';
     };
   };