Skip to content

Commit 6a20b3c

Browse files
committed
really basic readme
1 parent 56c3e12 commit 6a20b3c

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# bubblehelp
2-
A manager to render, contextualize and manage Bubbletea keybinds globally
2+
A manager to render, contextualize and manage BubbleTea keybinds globally
3+
4+
# Introduction
5+
When working on a complex application in the terminal, it's important to have a good
6+
way of managing multiple contexts with different keybinds, same keys but different outcome,
7+
and so on.
8+
9+
I was facing troubles, when trying to manage dynamic keybinds and on top of that the need
10+
of rendering help. The BubbleTea library is amazing, but it lack something to manage the
11+
keybinds well.
12+
13+
That's why I've created bubblehelp. It's just a coat of quality of life to help you write
14+
contextualized TUI application with complex ever-changing help for your users.
15+
16+
Take a look at the example and let your imagination do the rest.
17+
18+
# Need help
19+
Do not hesitate to create an issue if you need any kind of help about bubblehelp.
20+
21+
# License
22+
MIT License
23+
24+
Copyright (c) 2025 Lionel Leeser
25+
26+
Permission is hereby granted, free of charge, to any person obtaining a copy
27+
of this software and associated documentation files (the "Software"), to deal
28+
in the Software without restriction, including without limitation the rights
29+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
30+
copies of the Software, and to permit persons to whom the Software is
31+
furnished to do so, subject to the following conditions:
32+
33+
The above copyright notice and this permission notice shall be included in all
34+
copies or substantial portions of the Software.
35+
36+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
37+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
38+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
39+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
40+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
41+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
42+
SOFTWARE.

0 commit comments

Comments
 (0)