From 5ddd2890435190f8b08b33cdb8d6cb6ae7fde66b Mon Sep 17 00:00:00 2001
From: Collin Williams <96917990+bluedragon1221@users.noreply.github.com>
Date: Wed, 6 Aug 2025 07:23:11 -0500
Subject: fzf-exec mostly done

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index dc001ca..0f9672b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
 # tmux-minibuffer
-Emacs minibuffer in tmux
+In emacs, the minibuffer refers to the bar at the bottom of the screen where you can type in commands.
+From emacs manual:
+> The minibuffer is where Emacs commands read complicated arguments, such as file names, buffer names, Emacs command names, or Lisp expressions.
+> - [Minibuffer (GNU Emacs Manual)](https://www.gnu.org/software/emacs/manual/html_node/emacs/Minibuffer.html)
+
+Emacs packages such as [vertico](https://github.com/minad/vertico) provide fancy completion inside the minibuffer.
+![vertico's M-x completion menu](./vertico-mx.png)
+
+What if we could have that kind of UX in tmux?
+`tmux-minibuffer` is a collection of scripts for interacting with tmux using popup windows at the bottom of the screen, simulating minibuffer completion plugins, such as vertico.
+
+## Scripts (so far)
+- [`fzf-exec`](./fzf-exec/README.md): replaces the default command prompt with a vertico-style completion menu.
+- [`broot-sessionizer`](./broot-sessionizer/README.md): A [Primeagen](https://github.com/ThePrimeagen/tmux-sessionizer)-esque sessionizer using broot as a directory picker
+
+Future ideas:
+- fzf-sessionizer
+- search scrollback (kinda like [fuzzback](https://github.com/roosta/tmux-fuzzback) or [swiper](https://github.com/abo-abo/swiper?tab=readme-ov-file#swiper))
+- define custom commands in fzf-exec
-- 
cgit v1.3.1