Upload README.md

README.md

@@ -1,3 +1,85 @@
+# FastSeek - macOS Spotlight-style File Search for Windows
 
-# anshdadhich/finder
+A blazing-fast file search tool for Windows that indexes all files using the NTFS Master File Table (MFT) directly, wrapped in a beautiful macOS Spotlight-style UI powered by Tauri.
 
+## Architecture
+
+```
+fastsearch-core/      (Rust library - your original engine)
+  ├── src/index/      (In-memory index + fuzzy search)
+  ├── src/mft/        (NTFS MFT reader + USN journal watcher)
+  └── src/utils/      (Drive detection)
+
+fastsearch-tauri/     (Tauri desktop app)
+  ├── src-tauri/src/  (Tauri backend + hotkeys + system tray)
+  └── ui/             (Spotlight-style HTML/CSS/JS frontend)
+```
+
+## Why Tauri?
+
+- **Keep your Rust core intact**: The entire MFT scanning, indexing, and search logic stays in Rust with zero changes
+- **Native Windows integration**: System tray, global hotkeys (Win+Space), native window management
+- **Beautiful UI**: HTML/CSS/JS frontend with macOS Spotlight aesthetics - blur effects, smooth animations
+- **Small footprint**: Tauri apps are ~3-5MB vs Electron's 100MB+
+- **Performance**: Rust backend + Web frontend = best of both worlds
+
+## Why NOT C#?
+
+- Your core is already Rust with deep Windows kernel integration (NTFS MFT parsing, USN journal watching)
+- Porting to C# would require rewriting all unsafe Win32 interop, MFT parsing, USN journal code
+- Rust → C# FFI is complex and loses performance advantages
+- Tauri gives you a better UI with less effort while keeping your Rust engine
+
+## Features
+
+- ⚡ **Instant search** - Indexes millions of files in seconds via NTFS MFT
+- 🔍 **Fuzzy matching** with ranking (exact → starts with → contains)
+- 📂 **Live index updates** via USN journal watching
+- 🎨 **Spotlight-style UI** with blur backdrop, smooth animations
+- ⌨️ **Global hotkeys**: `Win+Space` to open, `ESC` to close
+- 🖱️ **Navigation**: `↑` `↓` arrows, `Enter` to open, `Ctrl+Enter` to reveal in Explorer
+- 💾 **Smart caching** - Compressed LZ4 cache with delta catch-up on restart
+- 🚫 **Directory exclusions** via UI
+
+## Building
+
+### Prerequisites
+- Rust toolchain (stable)
+- Windows (requires Administrator for MFT access)
+- Node.js (for Tauri CLI)
+
+### Step 1: Install Tauri CLI
+```bash
+cargo install tauri-cli
+```
+
+### Step 2: Build
+```bash
+cd fastsearch-tauri
+cargo tauri build
+```
+
+### Step 3: Run (Administrator required for MFT scanning)
+```bash
+cargo tauri dev
+```
+
+The built executable will be in `fastsearch-tauri/src-tauri/target/release/`.
+
+## Usage
+
+1. Press `Win+Space` anywhere to open the search
+2. Type to search files instantly
+3. Use `↑` `↓` to navigate results
+4. `Enter` opens the file/folder
+5. `Ctrl+Enter` reveals in File Explorer
+6. `ESC` closes the search
+
+## Original Engine
+
+The core file search engine (in `fastsearch-core/`) was written by **anshdadhich** and uses:
+- Direct NTFS MFT reading for lightning-fast indexing
+- USN (Update Sequence Number) journal for live file system tracking
+- In-memory arena-based index with binary search lookups
+- LZ4-compressed persistent cache
+- Rayon's parallel iterators for search