Skip to content

docs: legends face for the public readme #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avalonreset wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: legends face for the public readme #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
<p align="center">
<img src="assets/banner.webp" alt="HyperYap - local voice-to-text for your desktop" width="100%">
<img src="assets/banner.webp" alt="HYPER YAP - local voice to text" width="100%">
</p>

# HyperYap - Local Voice-to-Text for Your Desktop
<p align="center">
<a href="https://github.com/avalonreset/hyperyap/actions/workflows/ci.yaml"><img src="https://github.com/avalonreset/hyperyap/actions/workflows/ci.yaml/badge.svg" alt="CI"></a>
<a href="https://github.com/avalonreset/hyperyap/releases"><img src="https://img.shields.io/github/v/release/avalonreset/hyperyap" alt="GitHub release"></a>
<a href="LICENSE"><img src="https://img.shields.io/github/license/avalonreset/hyperyap" alt="License: AGPL-3.0"></a>
</p>

Speak. It types. Nothing leaves the machine.

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Qualify the “nothing leaves the machine” promise

When a user enables the supported remote LLM provider, HyperYap sends the transcription to the configured server (src-tauri/src/llm/llm.rs:107-145), and this README still advertises that option at lines 41 and 185. The categorical promise is therefore false for a documented configuration and could mislead privacy-sensitive users; limit it to local/default processing or explicitly note the remote-mode exception.

AGENTS.md reference: AGENTS.md:L29-L30

Useful? React with 👍 / 👎.


[![CI](https://github.com/avalonreset/hyperyap/actions/workflows/ci.yaml/badge.svg)](https://github.com/avalonreset/hyperyap/actions/workflows/ci.yaml)
[![GitHub release](https://img.shields.io/github/v/release/avalonreset/hyperyap)](https://github.com/avalonreset/hyperyap/releases)
[![License: AGPL-3.0](https://img.shields.io/github/license/avalonreset/hyperyap)](LICENSE)
[![Last Commit](https://img.shields.io/github/last-commit/avalonreset/hyperyap)](https://github.com/avalonreset/hyperyap/commits/main)
HyperYap is local voice-to-text for Windows, macOS, and Linux. It runs NVIDIA Parakeet on your computer, pastes into the app you already have focused, and collects no data.

HyperYap is a privacy-first voice-to-text app that runs speech recognition locally on your machine. It uses NVIDIA Parakeet, collects no data, and gives you fast recording, automatic paste, configurable shortcuts, optional LLM cleanup, and terminal-friendly workflow helpers.
The public installer is still a standalone app. On a Legends desk, the same engine can live as a module inside Legends Bridge so push-to-talk keeps working when Chrome is closed. Bridge is not required to use HyperYap.

## Table of Contents

Expand Down
Binary file modified assets/banner.webp
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/social-previews/social-preview-1.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading