From a6ed575b09bf89b4941f2ded112e369723b21562 Mon Sep 17 00:00:00 2001
From: erangel1 <asgardlabs@proton.me>
Date: Tue, 5 May 2026 21:08:54 +0200
Subject: [PATCH] edited readme file

---
 README.md | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 6cf8a467..1ee8a865 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,7 @@
 ---
 
 ## 🚀 The Vision
+
 Documentation in a HomeLab often falls into two extremes: overly complex enterprise tools like NetBox or static notes that quickly become outdated[cite: 1]. **LabGraph** bridges this gap by prioritizing automated discovery, visual clarity, and context-aware documentation[cite: 1]. It allows you to see the exact relationship between a physical server in your rack and the digital services running within it[cite: 1, 2].
 
 ---
@@ -12,21 +13,25 @@ Documentation in a HomeLab often falls into two extremes: overly complex enterpr
 ## ✨ Key Features
 
 ### 🔍 Automated Discovery & Monitoring
+
 * **Hypervisor/Runtime Sync:** Background workers pull real-time inventory from Proxmox VE, Docker, and TrueNAS APIs[cite: 1, 2].
 * **Active Monitoring:** Integrated heartbeat service performing ICMP pings and HTTP/HTTPS status checks for live "Up/Down" indicators[cite: 2].
 * **Network Scanning:** Scheduled tasks to scan subnets and identify undocumented "rogue" devices via Nmap[cite: 2].
 
 ### 🗺️ Visualization Suite
+
 * **Hierarchical "Drill-Down":** A nested accordion list view showing the chain from Physical Location → Hardware Host → Virtualization Layer → VM/Container → Application[cite: 1, 2].
 * **Interactive Topology Map:** A dynamic network graph powered by **React Flow** that auto-arranges nodes based on gateway relationships[cite: 2].
 * **Contextual Sidebar:** Click any node to see technical specs (IP, MAC, Port), resource sparklines, and documentation instantly[cite: 2].
 
 ### 📖 Knowledge & Lifecycle Management
+
 * **Integrated Markdown Wiki:** Every node has an associated "Sidecar" Markdown file for technical notes, rendered directly in the detail view[cite: 1, 2].
 * **Maintenance Logs:** A chronological event ledger to track hardware swaps, thermal paste changes, and upgrades[cite: 1, 2].
 * **Global Command Palette:** Use `Ctrl + K` to search for any device, IP, or wiki entry instantly[cite: 2].
 
 ### ⚡ HomeLab Utilities
+
 * **Power & Cost Estimator:** Input wattage for hardware to calculate total rack draw and monthly electricity costs[cite: 1, 2].
 * **IPAM:** Dedicated tracker for VLAN IDs, CIDR ranges, and IP exhaustion[cite: 1, 2].
 * **Public Status Page:** A toggleable, read-only dashboard for family members to check service status[cite: 1, 2].
@@ -34,6 +39,7 @@ Documentation in a HomeLab often falls into two extremes: overly complex enterpr
 ---
 
 ## 🛠️ Tech Stack
+
 * **Frontend:** React, TypeScript, Tailwind CSS (DaisyUI), React Flow[cite: 1, 3].
 * **Backend:** Python, Django Rest Framework (DRF)[cite: 1, 3].
 * **Task Queue:** Celery & Redis (for background scans and heartbeats).
@@ -47,20 +53,25 @@ Documentation in a HomeLab often falls into two extremes: overly complex enterpr
 This project is optimized for development using **VS Code Dev Containers**.
 
 1. **Clone the repository:**
+
    ```bash
    git clone [https://github.com/your-username/LabGraph.git](https://github.com/your-username/LabGraph.git)
    cd LabGraph
    
 2. **Open in VS Code:**
-```bash
-code .
-```
+
+   ```bash
+   code .
+   ```
 
 3. **Reopen in Container:**
+
    When prompted, select **"Reopen in Container"** to build the environment (includes Python, Node.js, PostgreSQL, and Redis).
 
 4. **Initialize the Environment:**
+
    Once the container is running, execute the following in the terminal:
+
    ```bash
    # Install dependencies
    pip install -r requirements.txt
@@ -77,6 +88,7 @@ code .
 ---
 
 ## 🎨 Branding & Identity
+
 The LabGraph logo is a geometric Connected Node Hexagon.  
 
 - The Shape: A hexagon representing a single data node.