Commit 6ab24a5
authored
docs: clarify TUI and CLI terminology in README (#51)
## Description
This PR updates the README documentation to clarify the distinction
between the TUI (Terminal User Interface) and CLI modes of the tool. The
changes make it clearer that the tool serves two purposes: an
interactive TUI mode for visual interaction and a traditional CLI mode
for scripting and automation.
## Type of Change
- [x] Documentation update
## Changes Made
- Updated tagline to describe the tool as "TUI + CLI" instead of just
"CLI"
- Clarified that interactive mode is a "TUI" (Terminal User Interface)
- Reorganized Usage section to clearly distinguish between TUI and CLI
modes
- Added explicit examples showing TUI mode vs CLI mode usage
- Updated feature list to highlight both TUI and CLI capabilities
- Improved clarity throughout by using precise terminology
## Testing
- [x] Documentation changes reviewed for clarity and accuracy
- [x] Build passes
- [x] All 192 tests pass
## Checklist
- [x] My code follows the code style of this project
- [x] I have performed a self-review of my own code
- [x] I have updated the documentation accordingly
- [x] My changes generate no new warnings
- [x] New and existing unit tests pass locally with my changes1 parent 31ca3f0 commit 6ab24a5
1 file changed
Lines changed: 19 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
| 31 | + | |
30 | 32 | | |
31 | 33 | | |
32 | | - | |
33 | | - | |
| 34 | + | |
34 | 35 | | |
35 | 36 | | |
36 | 37 | | |
| |||
53 | 54 | | |
54 | 55 | | |
55 | 56 | | |
56 | | - | |
| 57 | + | |
57 | 58 | | |
58 | 59 | | |
59 | | - | |
| 60 | + | |
60 | 61 | | |
61 | 62 | | |
62 | 63 | | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
63 | 74 | | |
64 | 75 | | |
65 | 76 | | |
| |||
160 | 171 | | |
161 | 172 | | |
162 | 173 | | |
163 | | - | |
| 174 | + | |
164 | 175 | | |
165 | 176 | | |
166 | 177 | | |
| |||
0 commit comments