Skip to content

Commit 55df19d

Browse files
committed
docs: update README and website with GIF demos and improvements
- Replace static screenshots with animated GIF demos in README and website - Change 'Screenshots' section to 'Demos' for accuracy - Remove redundant 'User Experience' section from README - Add unified demos section to website with side-by-side layout - Reorganize quickstart section: Desktop App first, then TUI - Add comprehensive quickstart instructions with prerequisites and first-run notes - Update tag format from v0.3.0 to tui-v0.3.0 in README - Add release process documentation to CONTRIBUTING.md - Add subtle dark grey grid accent pattern to website background - Change arrow indicators from teal to white for better visibility - Ensure consistent ordering (Desktop App first) across all sections
1 parent f84bc24 commit 55df19d

14 files changed

Lines changed: 138 additions & 120 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5151

5252
[0.1.0]: https://github.com/hate/keyless/releases/tag/v0.1.0
5353

54-
## [0.3.0] - 2025-11-11
54+
## [0.3.0] - 2025-11-12
5555

5656
### Added
5757

CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,59 @@ fn test_file_write() -> Result<(), Box<dyn std::error::Error>> {
222222

223223
---
224224

225+
## Releases
226+
227+
Releases are automated via GitHub Actions workflows that trigger on git tags.
228+
229+
### Release Types
230+
231+
- **TUI releases**: Tag format `tui-v*` (e.g., `tui-v0.3.0`)
232+
- **Desktop releases**: Tag format `desktop-v*` (e.g., `desktop-v0.3.0`)
233+
234+
### Creating a Release
235+
236+
1. **Update versions** in all relevant files:
237+
- `Cargo.toml` (workspace version)
238+
- `keyless-desktop/src-tauri/Cargo.toml` (desktop package version)
239+
- `keyless-desktop/src-tauri/tauri.conf.json` (desktop app version)
240+
241+
2. **Update CHANGELOG.md** with the new version and changes
242+
243+
3. **Commit version changes**:
244+
```bash
245+
git add Cargo.toml keyless-desktop/src-tauri/Cargo.toml keyless-desktop/src-tauri/tauri.conf.json CHANGELOG.md
246+
git commit -m "chore: bump version to X.Y.Z"
247+
```
248+
249+
4. **Create and push the tag**:
250+
```bash
251+
# For TUI release
252+
git tag tui-v0.3.0
253+
git push origin tui-v0.3.0
254+
255+
# For Desktop release
256+
git tag desktop-v0.3.0
257+
git push origin desktop-v0.3.0
258+
259+
# Or both
260+
git tag tui-v0.3.0 desktop-v0.3.0
261+
git push origin tui-v0.3.0 desktop-v0.3.0
262+
```
263+
264+
5. **GitHub Actions will automatically**:
265+
- Build binaries/installers for all platforms
266+
- Create a GitHub Release with artifacts attached
267+
- Use the tag name as the release name
268+
269+
### Versioning
270+
271+
We follow [Semantic Versioning](https://semver.org/):
272+
- **MAJOR** (X.0.0): Breaking changes
273+
- **MINOR** (0.X.0): New features, backwards compatible
274+
- **PATCH** (0.0.X): Bug fixes, backwards compatible
275+
276+
---
277+
225278
## License
226279

227280
By contributing, you agree that your contributions will be licensed under the MIT License.

README.md

Lines changed: 7 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -57,36 +57,6 @@ The goal is a tool you can trust: local and no accounts. Choose the interface th
5757
- High-quality resampling via rubato (supports all device sample rates)
5858
- Auto mic rate (device default; prefers 48 kHz; caps high rates)
5959

60-
**User Experience**
61-
62-
**TUI (Terminal):**
63-
- Phased, non-blocking startup with a responsive terminal interface
64-
- Loading overlay with granular Whisper steps; press [esc] to cancel
65-
- Resumable model downloads with progress; press [esc] to pause, [backspace] to cancel (deletes partial)
66-
- Clear live info panel while dictating: mic, sink, time (session), model, language, words (session)
67-
- Config screen shows lifetime counters: total words and total talk time (persisted)
68-
- Audio feedback: gentle beeps on PTT press/release and successful transcription delivery
69-
70-
**Desktop App (Beta)** 🎉
71-
- **Native desktop application** built with Tauri v2 + React + TypeScript
72-
- Modern, responsive UI with smooth animations
73-
- System tray integration with quick access menu
74-
- Full feature parity with TUI version
75-
- **Listening Pill Overlay**: Bottom-center indicator with animated EQ bars showing real-time audio levels and VAD state
76-
- **Toast Notifications**: Top-right notifications displaying transcription results
77-
- Shows real-time preview text while speaking
78-
- Displays final transcription with word count and output destination (paste/clipboard/file) after PTT release
79-
- Sink branding flashes in background on final delivery
80-
- Always-on-top, non-intrusive overlays with smooth animations
81-
- **Comprehensive settings UI**
82-
- General, AI, and VAD settings with real-time persistence
83-
- Model management with download progress tracking
84-
- Onboarding flow for first-time users
85-
- **System integration**
86-
- macOS/Windows/Linux support
87-
- Microphone and accessibility permission handling
88-
- Configurable hotkeys (control+option, control+shift)
89-
9060
## 🚀 Quick Start
9161

9262
### Desktop App (Beta) 🎉
@@ -151,7 +121,7 @@ cargo build --release
151121
cargo install --git https://github.com/hate/keyless --package keyless --locked
152122

153123
# Or pin a release tag
154-
cargo install --git https://github.com/hate/keyless --tag v0.3.0 --package keyless --locked
124+
cargo install --git https://github.com/hate/keyless --tag tui-v0.3.0 --package keyless --locked
155125

156126
# Update existing install
157127
cargo install --git https://github.com/hate/keyless --package keyless --locked --force
@@ -166,16 +136,15 @@ Note: CUDA is an optional feature flag on the same install; use `--features cuda
166136
**First run:** Downloads Whisper model
167137
**Usage:** Press Control+Option (configurable) to start dictating
168138

169-
## 📸 Screenshots
139+
## 📸 Demos
170140

171-
**TUI (Terminal) Version:**
172-
- **Configuration View:** Model selection, output mode, and settings
173-
- **Running View:** Real-time transcription with EQ visualization
141+
**Desktop App (Beta):**
174142

175-
![Configuration screen](assets/config.png)
176-
![Transcription demo](assets/transcribe.png)
143+
![Desktop app demo](assets/keylessDESKTOP.gif)
144+
145+
**TUI (Terminal) Version:**
177146

178-
**Desktop App:** See the [Desktop App Guide](keyless-desktop/README.md) for screenshots and UI details.
147+
![TUI demo](assets/keylessTUI.gif)
179148

180149
## 🔧 How It Works
181150

assets/config.png

-438 KB
Binary file not shown.

assets/keylessDESKTOP.gif

64.5 MB
Loading

assets/keylessTUI.gif

2.41 MB
Loading

assets/transcribe.png

-351 KB
Binary file not shown.

keyless-website/public/images/.gitkeep

Whitespace-only changes.
-438 KB
Binary file not shown.
-351 KB
Binary file not shown.

0 commit comments

Comments
 (0)