commit cf5957fb63c8c847d811b724130ff26333b7da99
parent 1569735cdc71dbb74da49b64144d95a3f451a9a6
Author: 1jehuang <[email protected]>
Date: Fri, 19 Dec 2025 04:11:23 -0800
Add README with benchmarks
Diffstat:
| A | README.md | | | 53 | +++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 53 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,53 @@
+# niri-workspaces-rs
+
+A fast, event-driven workspace indicator for [Waybar](https://github.com/Alexays/Waybar) and [niri](https://github.com/YaLTeR/niri).
+
+## Features
+
+- **Visual bars** instead of numbers - each window is a colored bar
+- **Color-coded by app** - Chrome (Google colors), Discord (purple), Firefox (orange), nvim (green), Claude (orange), Codex (cyan)
+- **Terminal app detection** - detects Claude/Codex/nvim running inside terminals via /proc
+- **Focused window indicator** - █ for focused, ▌ for would-be-focused, | for others
+- **Dimmed unfocused workspaces** - colors are dimmed when workspace isn't focused
+- **Daemon mode** - persistent socket connection, no process spawning
+
+## Benchmarks
+
+| Metric | Value |
+|--------|-------|
+| Memory | 2.5 MB RSS |
+| CPU per update | ~1.1ms |
+| 80 rapid switches | ~90ms total CPU |
+
+### Comparison
+
+| Approach | CPU per update |
+|----------|---------------|
+| Bash script | ~340ms |
+| Rust + signal | ~12-14ms |
+| Rust daemon | **~1.1ms** |
+
+The daemon is **~10-12x faster** than the signal-based approach and **~300x faster** than the original bash script.
+
+## Installation
+
+```bash
+cargo build --release
+cp target/release/niri-workspaces ~/.config/waybar/
+```
+
+## Waybar Configuration
+
+```json
+"custom/workspaces": {
+ "exec": "/home/user/.config/waybar/niri-workspaces",
+ "return-type": "json",
+ "format": "{}"
+}
+```
+
+No `interval` or `signal` needed - the daemon outputs JSON whenever workspace/window events occur.
+
+## License
+
+MIT
