docs: update README to improve clarity and add credits

This commit is contained in:
sankalp committed 2025-10-10 11:57:32 +05:45
1 parent f857d20b27
commit 09ab061151
1 file changed
+7 -11
+7 -11
View File
@@ -1,9 +1,7 @@
<div align="center"> <div align="center">
<img src="assets/logo.png" alt="Project Logo"> <img src="assets/logo.png" alt="Project Logo", height="200">
# KeyVibe > A CLI tool that brings realistic mechanical keyboard sounds to every keystroke.
> A C-based 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. 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 `<pack-name>/` directory:
- `config.json` (format matches bundled packs) - `config.json` (format matches bundled packs)
- Audio files referenced by `config.json` - Audio files referenced by `config.json`
Resolution order when selecting `-s <name>`:
1. `~/.local/share/keyvibe/audio/<name>/`
2. `/usr/share/keyvibe/audio/<name>/`
List shows `(user)` or `(system)` source next to each pack.
## 🤝 Contributing ## 🤝 Contributing
PRs welcome. Please keep code modular and readable, and prefer small, focused changes. 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 ## 📄 License
MIT — see [LICENSE](LICENSE). MIT — see [LICENSE](LICENSE).
## 🙏 Credits
- [MechVibes](https://github.com/hainguyents13/mechvibes) for sound packs
- [showmethekey](https://github.com/AlynxZhou/showmethekey) for code