From 83c7566e6cd4cbe6db7a9d829c848b568c33d2b8 Mon Sep 17 00:00:00 2001
From: Max Litruv Boonzaayer <litruv@gmail.com>
Date: Fri, 2 Jan 2026 13:49:01 +1100
Subject: [PATCH] updated readme

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 38 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 5f01ec1..6c6ed45 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,16 @@ A modern, accessible documentation viewer for Markdown files with live search, n
 
 ## Features
 
-- 🔍 Live search with keyboard shortcuts (Alt+S)
-- 📱 Mobile-friendly responsive design
-- 🎯 Keyboard navigation support
-- 📑 Auto-generated document outline
-- 🔗 Wiki-style internal linking
-- 🖨️ Print-friendly styling
-- ♿ ARIA-compliant accessibility
-- 🌙 Dark theme
+- 🔍 **Live search** with keyboard shortcuts (Alt+S) and result caching
+- 📱 **Mobile-friendly** responsive design with focus trap
+- 🎯 **Keyboard navigation** support (arrow keys, Enter, Escape)
+- 📑 **Auto-generated document outline** with collapsible headers
+- 🔗 **Wiki-style internal linking** with `[[Page Title]]` syntax
+- 🖨️ **Print-friendly** styling
+- ♿ **ARIA-compliant accessibility** (aria-current, role attributes, focus management)
+- 🌙 **Dark theme** with CSS custom properties
+- ⚡ **Performance optimized** with document caching and lazy loading
+- 📊 **Loading indicators** with animated progress bars
 
 ## Quick Start
 
@@ -124,13 +126,30 @@ To use the plugin:
 
 ```
 .
-├── docs/           # Documentation files
-├── build-docs.js   # Documentation builder
-├── index.html      # Main viewer
-├── index.js        # Application logic
-└── styles.css      # Styling
+├── docs/               # Documentation files
+├── js/                 # Application modules
+│   ├── EventBus.js     # Pub-sub event system
+│   ├── IndexService.js # Document index management
+│   ├── SearchService.js# Search with caching
+│   ├── DOMService.js   # DOM manipulation & accessibility
+│   ├── DocumentService.js # Markdown loading & caching
+│   ├── NavigationService.js # Browser history handling
+│   └── Documentation.js # Main orchestrator
+├── build-docs.js       # Documentation builder
+├── index.html          # Main viewer
+└── styles.css          # Styling
 ```
 
+### Architecture
+
+The application uses a modular ES6 architecture with:
+
+- **EventBus**: Pub-sub pattern for decoupled communication between services
+- **Services**: Single-responsibility modules for search, DOM, documents, and navigation
+- **Caching**: LRU caches for search results (50 entries) and documents (20 entries)
+- **Lazy Loading**: Images use `loading="lazy"` for improved performance
+
+
 ### Building
 
 The build process:
@@ -201,6 +220,12 @@ The build process generates the documents part for `index.json`
 2. Create a feature branch
 3. Submit a pull request
 
+## Dependencies
+
+- [marked.js](https://marked.js.org/) - Markdown parsing
+- [highlight.js](https://highlightjs.org/) - Syntax highlighting
+- [Font Awesome](https://fontawesome.com/) - Icons
+
 ## License
 
 MIT License - see LICENSE file for details.