From 09ab061151e6a4b808b3fb5f41ee62c7bb73d131 Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Fri, 10 Oct 2025 11:57:32 +0545 Subject: [PATCH] docs: update README to improve clarity and add credits --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b8c7934..e921e41 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@
- Project Logo + Project Logo -# KeyVibe - -> A C-based CLI tool that brings realistic mechanical keyboard sounds to every keystroke. +> A CLI tool that brings realistic mechanical keyboard sounds to every keystroke. KeyVibe listens to your keyboard events and plays high‑quality switch sounds with low latency. It ships with multiple sound packs and supports your own custom packs. Run it interactively or as a background daemon with live reload of your preferences. @@ -92,13 +90,6 @@ Required files inside each `/` directory: - `config.json` (format matches bundled packs) - Audio files referenced by `config.json` -Resolution order when selecting `-s `: - -1. `~/.local/share/keyvibe/audio//` -2. `/usr/share/keyvibe/audio//` - -List shows `(user)` or `(system)` source next to each pack. - ## 🤝 Contributing PRs welcome. Please keep code modular and readable, and prefer small, focused changes. @@ -106,3 +97,8 @@ PRs welcome. Please keep code modular and readable, and prefer small, focused ch ## 📄 License MIT — see [LICENSE](LICENSE). + +## 🙏 Credits + +- [MechVibes](https://github.com/hainguyents13/mechvibes) for sound packs +- [showmethekey](https://github.com/AlynxZhou/showmethekey) for code