Upload README.md

README.md

@@ -1,83 +1,119 @@
 # FastSeek - macOS Spotlight-style File Search for Windows
 
-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.
+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 v2**.
 
 ## 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)
+fastsearch-core/          (Rust library — your original engine, unchanged)
+  ├── src/index/search.rs  (Fuzzy search with rayon parallelism)
+  ├── src/index/store.rs   (In-memory arena index + LZ4 cache)
+  ├── src/mft/reader.rs    (Direct NTFS MFT parsing)
+  ├── src/mft/watcher.rs   (USN journal live updates)
+  └── src/utils/drives.rs  (NTFS drive detection)
+
+fastsearch-tauri/         (Tauri v2 desktop app)
+  ├── src-tauri/
+  │   ├── src/main.rs      (Backend: tray, global shortcuts, window mgmt)
+  │   ├── capabilities/    (Tauri v2 permissions system)
+  │   ├── tauri.conf.json  (v2 config)
+  │   └── Cargo.toml       (v2 deps + plugins)
+  └── ui/
+      ├── index.html       (Spotlight-style layout)
+      ├── styles.css       (Frosted glass, dark theme, animations)
+      └── app.js           (Instant search, keyboard nav)
 ```
 
-## Why Tauri?
+## Why Tauri v2?
 
-- **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
+- **Keep your Rust core intact** — MFT scanning, indexing, and search logic stays in Rust with zero changes
+- **Native Windows integration** — System tray, global shortcuts (Win+Space), native window management
+- **Beautiful UI** — HTML/CSS/JS frontend with macOS Spotlight aesthetics: blur effects, smooth animations
+- **Small footprint** — ~5-10MB vs Electron's 100MB+
+- **Capabilities-based security** — Tauri v2's permission model
 
 ## 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
+- 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
+- ⚡ **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
+- ⌨️ **Global shortcuts**: `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
+- 💾 **Smart caching** — Compressed LZ4 cache with delta catch-up on restart
 - 🚫 **Directory exclusions** via UI
+- 🔔 **System tray** — Menu with Show/Quit, left-click to toggle
 
-## Building
+## Prerequisites
 
-### Prerequisites
-- Rust toolchain (stable)
-- Windows (requires Administrator for MFT access)
-- Node.js (for Tauri CLI)
+- **Rust** toolchain (stable, ≥ 1.77.2) — [rustup.rs](https://rustup.rs/)
+- **Windows 10/11** (NTFS MFT scanning won't work on Linux/Mac)
+- **Administrator** privileges (required for MFT direct access)
+- **Microsoft Edge WebView2** (usually pre-installed on Win10/11)
 
-### Step 1: Install Tauri CLI
-```bash
-cargo install tauri-cli
-```
+## Clone & Build
 
-### Step 2: Build
 ```bash
+# 1. Clone
+git clone https://huggingface.co/anshdadhich/finder
+cd finder
+
+# 2. Build & run in dev mode (admin PowerShell)
 cd fastsearch-tauri
+cargo tauri dev
+
+# 3. Build release installer
 cargo tauri build
 ```
 
-### Step 3: Run (Administrator required for MFT scanning)
-```bash
-cargo tauri dev
+Release artifacts:
+```
+src-tauri/target/release/fastsearch-tauri.exe   (standalone)
+src-tauri/target/release/bundle/msi/*.msi        (Windows installer)
+src-tauri/target/release/bundle/nsis/*.exe       (NSIS installer)
 ```
 
-The built executable will be in `fastsearch-tauri/src-tauri/target/release/`.
+> **Important**: Run PowerShell **as Administrator** before `cargo tauri dev`. The MFT scanner requires elevated privileges.
 
 ## 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
+| Shortcut | Action |
+|----------|--------|
+| `Win + Space` | Open/close search overlay |
+| `ESC` | Close search |
+| `↑` / `↓` | Navigate results |
+| `Enter` | Open file/folder |
+| `Ctrl + Enter` | Reveal in File Explorer |
+
+## Troubleshooting
+
+| Error | Fix |
+|-------|-----|
+| `"identifier" is a required property` | Your `cargo tauri` is v1. Upgrade: `cargo install tauri-cli --force` |
+| `No NTFS drives found` | Run as Administrator |
+| Icons missing during build | Create placeholder PNGs in `src-tauri/icons/` or comment the `icon` array in `tauri.conf.json` |
+
+## Tech Stack
+
+| Layer | Technology |
+|-------|-----------|
+| Core engine | Rust (`windows` crate, MFT direct read, USN journals, LZ4, rayon) |
+| Desktop framework | Tauri v2 |
+| Global shortcuts | `tauri-plugin-global-shortcut` v2 |
+| Shell/open | `tauri-plugin-shell` v2 |
+| Frontend | Plain HTML/CSS/JS (no build step needed) |
+| UI style | macOS Spotlight-inspired (frosted glass, dark theme) |
 
 ## Original Engine
 
-The core file search engine (in `fastsearch-core/`) was written by **anshdadhich** and uses:
+The core file search engine (`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