Skip to content

docs: improve README with features and rationale #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devspexx merged 1 commit into from
Apr 4, 2026
Merged

docs: improve README with features and rationale #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down