goofy ah

1 files changed, 138 insertions, 0 deletions

diff --git a/doc/TUI.md b/doc/TUI.md
new file mode 100644
index 0000000..ff1a501
--- /dev/null
+++ b/doc/TUI.md
@@ -0,0 +1,138 @@
+# TUI Usage
+
+dis da fun mode. makes u feel like hackerman or smth, launch it with:
+
+```bash
+hoardom --tui
+```
+
+or from source like a true alpha:
+
+```bash
+cargo run -- --tui
+```
+
+you can also pass CLI flags alongside `--tui` and theyll apply as the starting config. like if you want to start with the Country list and some prioritized TLDs:
+
+```bash
+hoardom --tui --list Country --top ch,li
+```
+
+## layout
+
+the TUI has a few panels:
+
+- **search bar** at the bottom: type your domain names here then obliterate enter to hacksor them
+- **results** in the middle: shows whats available and whats taken
+- **favorites** on the right side: your watchlist on pulling the trigger and shelling out moneu for em domainers
+- **settings** below favorites: toggle stuff duh
+- **scratchpad** on the left (if enabled in toggler settings): just a little text area for gathering inspiration and other stuff like amongus memes or the bee movie script (saves to config.toml btw so u dont loose your mommy asmr converted to base64 that you saved in ur notes)
+
+and since version 2.0.1 theres also a top bar with an export button and help button.
+
+## searching
+
+type a domain suffix or full domain in the search bar and press Enter. you can search multiple things at once seperated by spaces or commas:
+
+```
+coolproject shitproject durchfall
+```
+
+or mix full domains and suffixes:
+
+```
+coolproject.ch shitproject
+```
+
+results stream in as they come back, theres a progress bar at the top of the results panel during a search.
+
+press `s` during a search to cancel it if youre impatient.
+
+if `Clear on Search` is off in settings, results accumulate across searches. press `C` to clear manually.
+
+## keyboard shortcuts
+
+### global
+| key | what |
+|-----|------|
+| `F1` | toggle help overlay |
+| `F2` | open/close export popup |
+| `Ctrl+C` | quit |
+| `s` | cancel running search |
+| `Tab` / `Shift+Tab` | cycle between panels |
+| `Esc` | close help/dropdown, or clear selection in current panel |
+
+### search bar
+| key | what |
+|-----|------|
+| `Enter` | start the search |
+| typing | works normally when no search is running |
+| `Home` / `End` | jump to start/end of input |
+
+### results
+| key | what |
+|-----|------|
+| `Up` / `Down` | navigate the list |
+| `Enter` | add highlighted domain to favorites |
+| mouse scroll | scroll through results |
+
+### favorites
+| key | what |
+|-----|------|
+| `Up` / `Down` | navigate |
+| `Backspace` / `Delete` | remove the focused favorite |
+
+### settings
+| key | what |
+|-----|------|
+| `Up` / `Down` | move between settings rows |
+| `Enter` / `Space` | toggle checkboxes or open the TLD list dropdown |
+
+### scratchpad
+as was already said... put whatever u want in here
+
+## mouse and scrolling support
+mouse is on by default. you can click and interact with stuff
+
+if you hate mouse in terminal apps (or your terminal doesnt like it for reasons) can be disabled :
+
+```bash
+hoardom --tui --no-mouse
+```
+
+## settings panel
+
+theres 4 things in there:
+
+- **TLD List** dropdown: pick Standard, Decent, Country, All, or any custom imported lists
+- **Show Unavailable** checkbox: toggles whether taken domains show with premium details in results
+- **Show Notes Panel** checkbox: toggles the scratchpad panel on the left
+- **Clear on Search** checkbox: if on, results get cleared before each new search. if off they pile up for the true hoarding feeling.
+
+oh and settings auto save to config 
+
+## favorites
+
+when you find a domain you like in the results, highlight it and press Enter to add it to favorites. favorites show up in the right panel and persist across sessions.
+
+if you (for whatever reason) decide to stop hoard domains in ther you can REMOVE THEM OMG WHAT CRAZY AHH FEATURE I KNOW RIGHT ???, focus the favorites panel, navigate to it, and hit Backspace or Delete.
+
+## export
+
+press `F2` or click the Export batten in the top bar.
+
+two modes:
+- **Favorites TXT**: dumps your favorites list to a text file, one per line, usefull if u wanna search em all for availability and shiet again.
+- **Results CSV**: exports currently visible results as CSV ... if u want that.
+
+will warn u when u bouta overwrite ur precious files and also last used export paths get remembered for faster extorting.
+
+## the too small thing
+
+if you resize the terminal too small, hoardom will refuse to work and complain about being claustrophone! please respect its feelings and dont scare it like that
+
+## tips
+
+- you can pass `--import-filter` alongside `--tui` to import a list and jump straight into the TUI with it
+- `--verbose` works in TUI too, it prints debug stuff to stderr (which you wont see in the TUI itself, but its there if you redirect it)
+- `--no-color` also works here for your 90's dial up crt tty