From 96447c0c2208acca6a64ee179722899177caac63 Mon Sep 17 00:00:00 2001
From: Spexx <46614224+devspexx@users.noreply.github.com>
Date: Sat, 4 Apr 2026 22:04:02 +0200
Subject: [PATCH] docs: improve README with features and rationale

Enhances README documentation by improving the features section
and adding a clear explanation of why ConfigurationAPI should be used.

Improves clarity, onboarding experience, and overall project presentation.
---
 README.md | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 2fca3b1..a6fc886 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,7 @@ A lightweight, high-performance YAML configuration API with automatic file watch
 
 ---
 
-## Features
-
+### Features
 - Automatic config reload on file changes (WatchService-based)
 - Atomic, thread-safe configuration swapping
 - Line-level diff tracking (changed / added / removed)
@@ -14,7 +13,12 @@ A lightweight, high-performance YAML configuration API with automatic file watch
 - Optimized (no regex, O(n) diff, minimal allocations)
 - Clean integration with Bukkit/Paper event system
 
----
+### Why ConfigurationAPI?
+
+- Eliminates manual reload logic
+- Provides insight into config changes (diffs)
+- Prevents unsafe concurrent access
+- Designed for high-performance plugin environments
 
 ## Installation