From a45bec91f619241669cab693735cdce844f6adbf Mon Sep 17 00:00:00 2001
From: Peritia <Peritia@peritia.space>
Date: Fri, 8 Aug 2025 13:41:45 +0200
Subject: [PATCH] update instructions

---
 README.md | 44 +++++++++++++++++++++++++++++---------------
 1 file changed, 29 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 66d3da7..03846dc 100644
--- a/README.md
+++ b/README.md
@@ -93,26 +93,40 @@ Nyx-Tools
 
 ```nix
 {
-  nyx.nyx-rebuild = {
-    enable = true;
-    inherit username nixDirectory;
+  nyx = {
+    # Global settings
+    enable       = true;
+    username     = username;
+    nixDirectory = nixDirectory;
+    logDir       = "${nixDirectory}/Logs";
+    autoPush     = true;
+
+    # Tool-specific settings
+    nyx-rebuild = {
+      enable           = true;
+      formatter        = "alejandra";
+      enableFormatting = false;
+      editor           = "nvim";
+      startEditor      = false;
+      enableAlias      = false;
+    };
+
+    nyx-cleanup = {
+      enable          = true;
+      keepGenerations = 5;
+      enableAlias     = false;
+    };
+
+    nyx-tool = {
+      enable = true;
+    };
   };
-  
-  nyx.nyx-cleanup = {
-    enable = true;
-    inherit username nixDirectory;
-  };
-  
-  nyx.nyx-tool = {
-    enable = true;
-    inherit nixDirectory;
-  };
-}
+  }
 ```
 
 > ⚠️ **Note**: `nixDirectory` must be a **full path** to your flake repo (e.g., `/home/${username}/NixOS/Nyx-Tools`).
 
-See `./other/example/home.nix` for a working example.
+See `other/example/example-home.nix` for a working example.
 
 ---