Update README.md

README.md

@@ -1,144 +1,154 @@
-# Autocorrect-Type
-
-![License](https://img.shields.io/github/license/not-algorembrant/autocorrect-type)
-![Repo Size](https://img.shields.io/github/repo-size/not-algorembrant/autocorrect-type)
-![Last Commit](https://img.shields.io/github/last-commit/not-algorembrant/autocorrect-type)
-![Rust](https://img.shields.io/badge/Rust-5-dea584)
-![Markdown](https://img.shields.io/badge/Markdown-2-083fa1)
-![TOML](https://img.shields.io/badge/TOML-1-9c4121)
-
-System-wide autocorrect for Windows. Runs silently in the background and fixes misspelled words as you type -- in any application (terminal, browser, Discord, search bar, etc.).
-
-Built with Rust + Windows API. No external APIs, no cloud dependencies, no AI -- fully offline and native.
-
-Handles 466k English words sourced from [english-words](https://github.com/dwyl/english-words).
-You can download the misspelling datasets [here](https://huggingface.co/datasets/algorembrant/generated-misspelling-words) and make sure to rename the file into `misspellings.txt` and place it on `*\data\` folder path.
-
-## Features
-
-- **System-wide** -- works in any text input across your entire system
-- **500+ common misspellings** -- instant, high-confidence corrections (e.g. `teh` -> `the`)
-- **Smart spell checking** -- edit-distance algorithm catches unknown typos against a 466k-word dictionary
-- **Clipboard-based replacement** -- corrections happen instantly, no visible cursor movement
-- **Case-preserving** -- respects your capitalization (`TEH` -> `THE`, `Teh` -> `The`)
-- **System tray** -- toggle on/off, runs silently in background
-- **Lightweight** -- single `.exe`, no runtime dependencies, tiny memory footprint
-
-## System Overview
-
-```mermaid
-graph TD
-    A[Keyboard Input] -->|WH_KEYBOARD_LL| B[hook.rs]
-    B -->|Word buffer| C{Trigger key?}
-    C -->|No| B
-    C -->|Yes| D[spellcheck.rs]
-    D -->|Known misspelling| E[Misspellings DB]
-    D -->|Unknown word| F[Edit-Distance Engine]
-    F -->|Match found| G[Dictionary - 466k words]
-    E --> H[replacer.rs]
-    G --> H
-    H -->|Clipboard swap| I[Corrected Text]
-    J[tray.rs] -->|Toggle / Exit| B
-    K[main.rs] -->|Init| B
-    K -->|Init| D
-    K -->|Init| J
-```
-
-## Requirements
-
-### To run the compiled `.exe`
-
-- Windows 10/11
-
-### To build from source
-
-- [Rust toolchain](https://rustup.rs/) (stable)
-
-## Build
-
-```bash
-cargo build --release
-```
-
-The binary will be at `target/release/autocorrect-type.exe`.
-
-## Usage
-
-### Run
-
-Double-click `autocorrect-type.exe` or run from terminal. The app appears in the system tray.
-
-```bash
-# if it didnt open then
-cargo run --release
-```
-
-### Controls
-
-| Action | How |
-|---|---|
-| Toggle ON/OFF | `Ctrl + Alt + A` or right-click tray icon |
-| Exit | Right-click tray -> "Exit" |
-
-### How it works
-
-1. Type normally in any application
-2. When you press **Space**, **Enter**, **Tab**, or punctuation, the app checks the word you just typed
-3. If it is a known misspelling or a close match to a dictionary word, it is instantly replaced via the clipboard (no cursor flicker)
-4. A small balloon notification shows the correction briefly
-
-## How the correction works (no cursor flicker)
-
-Unlike typical autocorrect tools that backspace and retype characters visibly, this engine uses a clipboard-based approach:
-
-1. Saves current clipboard contents
-2. Sends backspaces to delete the misspelled word
-3. Copies the correction to the clipboard
-4. Simulates `Ctrl+V` to paste instantly
-5. Restores the original clipboard
-
-This makes corrections appear instantaneous with no visible cursor movement.
-
-## Customization
-
-### Add words to the dictionary
-
-Add words to `data/user_words.txt` (one per line, auto-created next to the `.exe`). Restart the app after editing.
-
-### Expand the misspellings database
-
-Edit `data/misspellings.txt`. Format: `misspelling=correction`, one per line. Lines starting with `#` are comments. The file is embedded at compile time.
-
-## Project Structure
-
-```text
-autocorrect-type/
-├── Cargo.toml
-├── Cargo.lock
-├── LICENSE
-├── README.md
-├── .gitignore
-├── src/
-|   ├── main.rs
-|   ├── hook.rs
-|   ├── spellcheck.rs
-|   ├── replacer.rs
-|   └── tray.rs
-└── data/
-    ├── words.txt
-    └── misspellings.txt
-```
-
-## Citation
-
-```bibtex
-@software{autocorrect_type,
-  author     = {Rembrant Oyangoren Albeos},
-  title      = {Autocorrect-Type},
-  year       = {2026},
-  publisher  = {Hugging Face},
-  url        = {https://huggingface.co/algorembrant/autocorrect-type}
-}
-```
-
-
+---
+license: mit
+datasets: generated-misspelling-words
+pipeline_tags: 
+- rust 
+- misspelling-words
+
+
+---
+
+# Autocorrect-Type
+
+![License](https://img.shields.io/github/license/not-algorembrant/autocorrect-type)
+![Repo Size](https://img.shields.io/github/repo-size/not-algorembrant/autocorrect-type)
+![Last Commit](https://img.shields.io/github/last-commit/not-algorembrant/autocorrect-type)
+![Rust](https://img.shields.io/badge/Rust-5-dea584)
+![Markdown](https://img.shields.io/badge/Markdown-2-083fa1)
+![TOML](https://img.shields.io/badge/TOML-1-9c4121)
+
+System-wide autocorrect for Windows. Runs silently in the background and fixes misspelled words as you type -- in any application (terminal, browser, Discord, search bar, etc.).
+
+Built with Rust + Windows API. No external APIs, no cloud dependencies, no AI -- fully offline and native.
+
+Handles 466k English words sourced from [english-words](https://github.com/dwyl/english-words).
+You can download the misspelling datasets [here](https://huggingface.co/datasets/algorembrant/generated-misspelling-words) and make sure to rename the file into `misspellings.txt` and place it on `*\data\` folder path.
+
+## Features
+
+- **System-wide** -- works in any text input across your entire system
+- **500+ common misspellings** -- instant, high-confidence corrections (e.g. `teh` -> `the`)
+- **Smart spell checking** -- edit-distance algorithm catches unknown typos against a 466k-word dictionary
+- **Clipboard-based replacement** -- corrections happen instantly, no visible cursor movement
+- **Case-preserving** -- respects your capitalization (`TEH` -> `THE`, `Teh` -> `The`)
+- **System tray** -- toggle on/off, runs silently in background
+- **Lightweight** -- single `.exe`, no runtime dependencies, tiny memory footprint
+
+## System Overview
+
+```mermaid
+graph TD
+    A[Keyboard Input] -->|WH_KEYBOARD_LL| B[hook.rs]
+    B -->|Word buffer| C{Trigger key?}
+    C -->|No| B
+    C -->|Yes| D[spellcheck.rs]
+    D -->|Known misspelling| E[Misspellings DB]
+    D -->|Unknown word| F[Edit-Distance Engine]
+    F -->|Match found| G[Dictionary - 466k words]
+    E --> H[replacer.rs]
+    G --> H
+    H -->|Clipboard swap| I[Corrected Text]
+    J[tray.rs] -->|Toggle / Exit| B
+    K[main.rs] -->|Init| B
+    K -->|Init| D
+    K -->|Init| J
+```
+
+## Requirements
+
+### To run the compiled `.exe`
+
+- Windows 10/11
+
+### To build from source
+
+- [Rust toolchain](https://rustup.rs/) (stable)
+
+## Build
+
+```bash
+cargo build --release
+```
+
+The binary will be at `target/release/autocorrect-type.exe`.
+
+## Usage
+
+### Run
+
+Double-click `autocorrect-type.exe` or run from terminal. The app appears in the system tray.
+
+```bash
+# if it didnt open then
+cargo run --release
+```
+
+### Controls
+
+| Action | How |
+|---|---|
+| Toggle ON/OFF | `Ctrl + Alt + A` or right-click tray icon |
+| Exit | Right-click tray -> "Exit" |
+
+### How it works
+
+1. Type normally in any application
+2. When you press **Space**, **Enter**, **Tab**, or punctuation, the app checks the word you just typed
+3. If it is a known misspelling or a close match to a dictionary word, it is instantly replaced via the clipboard (no cursor flicker)
+4. A small balloon notification shows the correction briefly
+
+## How the correction works (no cursor flicker)
+
+Unlike typical autocorrect tools that backspace and retype characters visibly, this engine uses a clipboard-based approach:
+
+1. Saves current clipboard contents
+2. Sends backspaces to delete the misspelled word
+3. Copies the correction to the clipboard
+4. Simulates `Ctrl+V` to paste instantly
+5. Restores the original clipboard
+
+This makes corrections appear instantaneous with no visible cursor movement.
+
+## Customization
+
+### Add words to the dictionary
+
+Add words to `data/user_words.txt` (one per line, auto-created next to the `.exe`). Restart the app after editing.
+
+### Expand the misspellings database
+
+Edit `data/misspellings.txt`. Format: `misspelling=correction`, one per line. Lines starting with `#` are comments. The file is embedded at compile time.
+
+## Project Structure
+
+```text
+autocorrect-type/
+├── Cargo.toml
+├── Cargo.lock
+├── LICENSE
+├── README.md
+├── .gitignore
+├── src/
+|   ├── main.rs
+|   ├── hook.rs
+|   ├── spellcheck.rs
+|   ├── replacer.rs
+|   └── tray.rs
+└── data/
+    ├── words.txt
+    └── misspellings.txt
+```
+
+## Citation
+
+```bibtex
+@software{autocorrect_type,
+  author     = {Rembrant Oyangoren Albeos},
+  title      = {Autocorrect-Type},
+  year       = {2026},
+  publisher  = {Hugging Face},
+  url        = {https://huggingface.co/algorembrant/autocorrect-type}
+}
+```
+
+