M README.md => README.md +63 -9
@@ 1,14 1,68 @@
-# Luke's dmenu
+# Kris's build of dmenu
-Extra stuff added to vanilla dmenu:
+My build of [dmenu](https://tools.suckless.org/dmenu/), the dynamic menu for X.
-- reads Xresources (ergo pywal compatible)
-- alpha patch, which importantly allows this build to be embedded in transparent st
-- can view color characters like emoji
-- `-P` for password mode: hide user input
-- `-r` to reject non-matching input
-- dmenu options are mouse clickable
+---
+
+## Features
+
+- **Xresources**: Read colors from `~/.Xresources` (pywal compatible)
+- **Alpha**: Transparency support, can be embedded in transparent st
+- **Emoji**: Can view color characters like emoji
+- **Password mode**: `-P` flag hides user input
+- **Reject non-matching**: `-r` flag rejects input that doesn't match an option
+- **Mouse clickable**: dmenu options are mouse clickable
+
+---
+
+## Patches
+
+| Patch | Description |
+|-------|-------------|
+| [xresources](https://tools.suckless.org/dmenu/patches/xresources/) | Read colors and settings from ~/.Xresources |
+| [alpha](https://tools.suckless.org/dmenu/patches/alpha/) | Transparency support |
+| [password](https://tools.suckless.org/dmenu/patches/password/) | Hide input for password entry |
+| mouse support | Click to select options |
+
+---
+
+## Usage
+
+```bash
+# Run dmenu
+dmenu_run
+
+# Password mode
+echo -e "option1\noption2" | dmenu -P
+
+# Reject non-matching input
+echo -e "yes\nno" | dmenu -r
+
+# With prompt
+dmenu -p "Select:" < options.txt
+```
+
+---
## Installation
-After making any config changes that you want, but `make`, `sudo make install` it.
+```bash
+git clone https://github.com/krisyotam/dmenu
+cd dmenu
+sudo make install
+```
+
+---
+
+## Other Suckless Repos
+
+- [dwm](https://github.com/krisyotam/dwm) - dynamic window manager
+- [st](https://github.com/krisyotam/st) - simple terminal
+- [dwmblocks](https://github.com/krisyotam/dwmblocks) - modular status bar
+
+---
+
+## Contact
+
+- Kris Yotam <krisyotam@protonmail.com>
+- [https://krisyotam.com](https://krisyotam.com)
A => +0 -0
A => +0 -0
A drw.o => drw.o +0 -0
A stest => stest +0 -0
A stest.o => stest.o +0 -0
A util.o => util.o +0 -0