tuidoscope 0.1.13 → 0.1.16

package/README.md

@@ -20,11 +20,24 @@ A centralized TUI management application for running multiple TUI applications i
 
 - **Embedded Terminals**: Run multiple TUIs in a single window using Ghostty's high-performance terminal emulator.
 - **Tab Management**: Organize and switch between different applications using a vertical sidebar.
-- **Command Palette**: Quickly search and switch between apps or perform actions with a fuzzy-search palette (Ctrl+P).
+- **Simple Modal Keyboard**: Two modes - TABS mode for navigation and TERMINAL mode for PTY input. Toggle with `Ctrl+A`.
+- **Command Palette**: Quickly search and switch between apps with a fuzzy-search palette (`Space`).
 - **Runtime Management**: Add, edit, and remove application entries directly within the app without restarting.
 - **Session Persistence**: Automatically remembers and restores your running applications and active tab between restarts.
-- **Highly Configurable**: Customize themes, keybinds, and application lists via YAML.
-- **Path Expansion**: Supports `~` and `<CONFIG_DIR>` tokens in working directory paths.
+- **Highly Configurable**: Customize themes and application lists via YAML.
+- **Path Expansion**: Supports `~`, `<CONFIG_DIR>`, and `<STATE_DIR>` tokens in paths.
+- **App Availability Detection**: Add Tab modal shows which TUI apps are installed on your system.
+
+## Documentation
+
+For detailed guides, see the [`docs/`](./docs/) directory:
+
+- [Getting Started](./docs/getting-started.md) - Installation and first run
+- [Configuration](./docs/configuration.md) - YAML config reference
+- [Apps](./docs/apps.md) - App configuration examples
+- [Troubleshooting](./docs/troubleshooting.md) - Common issues and solutions
+
+See also: [CONFIG.md](./CONFIG.md) for a comprehensive configuration reference.
 
 ## Tech Stack
 
@@ -93,39 +106,60 @@ bun run typecheck
 
 ## Configuration
 
-Tuidoscope looks for a configuration file at `~/.config/tuidoscope/config.yaml`. It also supports a local `tuidoscope.yaml` in the current working directory for project-specific setups.
+Tuidoscope looks for a configuration file at `~/.config/tuidoscope/tuidoscope.yaml`. It also supports a local `tuidoscope.yaml` in the current working directory for project-specific setups.
+
+### Keyboard Shortcuts
+
+Tuidoscope uses a simple two-mode system:
 
-### Default Keybinds
+- **`Ctrl+A`** - Toggle between TABS and TERMINAL mode
+- **Double-tap `Ctrl+A`** - Send `Ctrl+A` to the terminal (useful for nested tmux/screen)
 
-| Action | Default Keybind |
-|--------|-----------------|
-| Next Tab | `Ctrl+N` |
-| Previous Tab | `Ctrl+P` |
-| Toggle Focus (Tabs/Terminal) | `Ctrl+A` |
-| New Tab | `Ctrl+T` |
-| Edit App | `Ctrl+E` |
-| Command Palette | `Ctrl+Space` (or `Ctrl+P`) |
-| Stop Current App | `Ctrl+X` |
-| Close Tab | `Ctrl+W` |
-| Restart Current App | `Ctrl+Shift+R` |
-| Kill All Apps | `Ctrl+Shift+K` |
-| Quit Tuidoscope | `Ctrl+Q` |
+**TABS Mode** (single keystrokes):
+
+| Key | Action |
+|-----|--------|
+| `j` / `k` | Navigate down/up in tab list |
+| `gg` | Jump to first tab |
+| `G` | Jump to last tab |
+| `Enter` | Select/start app |
+| `Space` | Open command palette |
+| `t` | Add new tab |
+| `e` | Edit selected app |
+| `x` | Stop selected app |
+| `r` | Restart selected app |
+| `K` | Kill all running apps |
+| `q` | Quit tuidoscope |
+
+**TERMINAL Mode**: All keystrokes pass through to the embedded terminal.
 
 ### Theme Customization
 
-You can customize the theme in your `config.yaml`:
+Default theme is Night Owl. Customize in your `tuidoscope.yaml`:
 
 ```yaml
 theme:
-  primary: "#7aa2f7"
-  background: "#1a1b26"
-  foreground: "#c0caf5"
-  accent: "#bb9af7"
-  muted: "#565f89"
+  primary: "#82aaff"      # Blue - selections
+  background: "#011627"   # Deep dark blue
+  foreground: "#d6deeb"   # Light text
+  accent: "#7fdbca"       # Cyan - active indicators
+  muted: "#637777"        # Gray - inactive elements
 ```
 
 ## Change Log
 
+### v0.3.0
+- **Simplified Keyboard System**: Replaced tmux-style leader key with simple focus-toggle model using `Ctrl+A`.
+- **Two-Mode Interface**: TABS mode for navigation (single keystrokes) and TERMINAL mode for PTY input.
+- **Enhanced Add Tab Modal**: Now shows app presets with availability detection directly in the modal.
+- **Streamlined Config**: Removed keybinds configuration - keyboard shortcuts are now fixed for consistency.
+
+### v0.2.0
+- **Leader Key System**: tmux-style configurable leader key (default `Ctrl+A`).
+- **App Availability Detection**: Preset list shows which apps are installed on your system.
+- **Expanded Presets**: 30+ TUI apps including AI coding agents (Claude, OpenCode, Aider, Gemini, Codex).
+- **Night Owl Theme**: Updated default theme to Night Owl color scheme.
+
 ### v0.1.0
 - Initial release.
 - Embedded terminal windows via `ghostty-opentui`.
@@ -135,6 +169,10 @@ theme:
 - Runtime application configuration (Add/Edit).
 - Path expansion for working directories.
 
+## Contributing
+
+Contributions are welcome! Please feel free to open an issue or submit a pull request on [GitHub](https://github.com/shuv1337/tuidoscope).
+
 ## Acknowledgments
 
 This project is built directly on top of: