joinmarket/yieldgenerator: add docs link to description

2024-07-29 11:22:47 +02:00
parent 5694408d3a
commit 74eb9a17b6
1 changed files with 8 additions and 1 deletions
@@ -73,7 +73,14 @@ let
    inherit (nbLib) cliExec;

    yieldgenerator = {
-      enable = mkEnableOption "JoinMarket yield generator bot";
+      enable = mkOption {
+        type = types.bool;
+        default = false;
+        description = ''
+          Enable the JoinMarket yield generator bot.
+          Documentation: https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/YIELDGENERATOR.md
+        '';
+      };
      ordertype = mkOption {
        type = types.enum [ "reloffer" "absoffer" ];
        default = "reloffer";