dsh-live-voice 0.5.0 → 0.5.2

package/README.md

@@ -1,128 +1,36 @@
 # DSH Live Voice
 
-**English (primary)** | [Português (Brasil)](https://github.com/victorwads/dsh-live-voice/blob/main/README.pt.md)
+Local-first speech-to-text (STT), text-to-speech (TTS), and meeting audio transcription plugin for DeepSeek Harness (DSH). Local speech processing does not make DSH or its AI provider fully offline.
 
-[![npm version](https://img.shields.io/npm/v/dsh-live-voice?logo=npm&label=npm&color=brightgreen)](https://www.npmjs.com/package/dsh-live-voice)
-[![Tested DSH](https://img.shields.io/badge/Tested_DSH-v0.2.1--alpha.2-5c5cff?logo=deepseek&logoColor=white)](https://github.com/deepseek-ai/deepseek-harness/releases/tag/dsh-v0.2.1-alpha.2)
-[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+## Installation
 
-**Tested and working with DeepSeek Harness v0.2.1-alpha.2.** This is the current tested DSH version, recorded in the `dshTestedVersion` field in [the main package manifest](package.json).
+Tested with **DeepSeek Harness v0.2.1-alpha.2**. The package manifest's `dshTestedVersion` field records the tested version.
 
-**Talk to your AI assistant, listen to its answers, and bring meeting context into the conversation—without constantly switching back to the keyboard.**
-
-DSH Live Voice is a local-first voice plugin for DeepSeek Harness (DSH), with speech-to-text (STT), text-to-speech (TTS), and real-time meeting transcription.
-*Built in Brazil 🇧🇷 and tested daily with Brazilian Portuguese on macOS.*
-
-## What can you do with it?
-
-- **Work by voice:** dictate a request, talk through code or documents, and hear the assistant’s response while staying focused on your work.
-- **Ask questions during meetings:** capture shared meeting audio alongside your microphone, review the transcript, and send relevant context to the DSH assistant while the discussion is still happening.
-- **Stay in control:** edit before sending, choose manual or automatic microphone delivery, and pause, resume, or stop spoken answers.
-- **Choose your speech setup:** use local recognition and speech engines where supported, or configure an HTTP endpoint. Local-first voice does not mean DSH or its AI provider is fully offline.
-
----
-
-## ⚡ Quick Start
-
-Install with `npx dsh` into your DSH web profile:
+Install the prebuilt package from npm; no source build is required. The Git repository contains source only.
 
 ```sh
 npx dsh plugin add --profile web dsh-live-voice
 ```
 
-Open **DSH Settings → Live Voice** after your next DSH startup.
-
----
-
-## 🌍 Interface Languages
-
-DSH Live Voice’s plugin interface is translated into the following languages. This refers to the visible plugin UI—not speech-recognition or text-to-speech language support.
-
-- 🇺🇸 **English**
-- 🇧🇷 **Portuguese (Brazil)**
-- 🇪🇸 **Spanish**
-- 🇫🇷 **French**
-- 🇮🇳 **Hindi**
-- 🇨🇳 **Chinese**
-
----
-
-## 📚 Documentation
-
-Detailed guides for deep-diving into engines and configurations:
-
-- ⚙️ **[Configuration & Conversation Flow Guide](https://github.com/victorwads/dsh-live-voice/blob/main/docs/CONFIGURATION.md)** — Settings overview, speaker vs. headphone modes, sequence diagrams, silence delays, and external engine setup.
-- 🧠 **[Choosing a Speech Recognition Engine](https://github.com/victorwads/dsh-live-voice/blob/main/docs/CHOOSING-AN-ENGINE.md)** — Comparison between Browser STT, Qwen3 ASR, and Whisper, with RAM footprints and OS compatibility.
-- 📖 **[The Story Behind the Project](HISTORY.md)** — Why this project was built and the human story behind coordinating voice.
-- 🆕 **[Release notes](https://github.com/victorwads/dsh-live-voice/blob/main/CHANGELOG.md)** — What changed in each version.
-
----
-
-## 🎯 Which Speech Engine Should I Use?
-
-| Scenario | Recommendation | RAM | Why |
-| --- | --- | --- | --- |
-| 🇧🇷 **Portuguese on macOS** | **Qwen3 ASR (HTTP API)** | ~1.5 GB | Best accuracy in daily maintainer use; current RAM usage reported by the maintainer. Whisper is second choice. |
-| 🇺🇸 **English on macOS** | **Browser SpeechRecognition** | ~0 GB | Built-in macOS/browser API. Fast, zero extra RAM. |
-| 🪟 **Windows** | **Qwen3 ASR** or **Whisper HTTP** | ~2–3 GB | Recommended starting point; Windows browser STT varies. |
-| 🌐 **Multilingual / Other** | **Whisper HTTP (auto)** | ~2 GB | Automatic language detection across dozens of languages. |
-
-👉 *For model requirements and server setup, see [Choosing a Speech Engine](https://github.com/victorwads/dsh-live-voice/blob/main/docs/CHOOSING-AN-ENGINE.md).*
-
----
-
-## ✨ Features at a Glance
-
-- 🎙️ **Voice Typing:** Append final recognized speech to the end of the DSH composer without replacing manual edits.
-- 👐 **Hands-Free Conversation:** Continuous dialogue that stays active across chat sessions.
-- ❓ **Spoken Structured Questions:** Narrates DSH prompt questions and submits your spoken answer.
-- ⌨️ **Optional Hold-to-Talk (Push-to-Talk):** Enable it in Settings, then hold `Control` anywhere on the page to speak; release to queue the message after the configured send delay. Disabled by default.
-- 🎧 **Acoustic Mode Isolation:** Gated listening for speakers (no echo) and open-mic interruption for headphones.
-- 🗣️ **Spoken Commands:** Control the chat using phrases like *"send"*, *"mute"*, *"clear"*, and *"stop speaking"*.
-- ⭐ **Dedicated Speech Bar:** Smoothly scrolling approximate captions, a moving highlight, previous/next navigation, pause/resume, stop, and a current/total segment counter. Captions show the text sent to the speech engine, without claiming word-level alignment.
-- 🧹 **Markdown-Aware Speech:** Remove formatting, announce links without reading full URLs, shorten file paths and line references, read checkbox states and table rows, and replace long code blocks with a localized notice. Preserve custom notices.
-- ⚡ **Responsive Conversation Settings:** Automatic-send delays of 600 ms, 800 ms, or 1–6 seconds (4 seconds by default), plus an assistant response delay of zero to 4 seconds (no delay by default). Recognition and synthesis still contribute to overall latency.
-- 🛠️ **Optional Live Voice Debugger:** Install `dsh-live-voice-debugger` separately to inspect runtime state and queues from the Developer tab in Live Voice Settings. The main plugin works without it.
-- 🏠 **Local-First Speech Options:** Use local engines such as Qwen or Whisper where supported. Browser recognition and configured HTTP services have their own processing requirements; do not assume every setup keeps audio on your machine.
-- 🌐 **Remote-Ready Host Audio:** Qwen and macOS Say synthesize on the DSH host, then DSH delivers compact audio to your browser—so playback works over remote and LAN connections.
-
-## 🧑‍💻 Meeting Mode — Real-Time Meeting Transcription and Live AI Q&A
-
-Keep an editable transcript of a meeting as it happens, then ask the DSH assistant questions about the discussion without having to retell it afterward. Use it for code reviews, project discussions, or working through a spreadsheet together.
-
-### From discussion to an answer
-
-1. Select **Qwen HTTP** or **Whisper HTTP** recognition in Live Voice Settings.
-2. Click the shared-audio icon beside the composer microphone and enable audio in the browser sharing dialog. Capture your microphone too when you want to include your own contributions.
-3. Review the transcript in the composer, add a question, and send the relevant context to DSH. For example: *“What decisions have we made so far?”*, *“Help us answer this point”*, or *“Compare this proposal with the project code.”* Answers depend on the transcript you send and the code, spreadsheet, or documents you make available to the agent.
-4. Read or listen to the answer while the meeting continues. For other participants to hear it, your meeting app must separately be configured to share the assistant’s playback audio.
-
-### You control what is captured and sent
-
-- Shared audio and your microphone have separate controls and can be stopped independently. Normal voice commands and assistant speech remain available.
-- With both sources capturing, source changes introduce `Me:` or `Them:`; consecutive chunks continue on new lines. These labels distinguish audio sources, **not individual meeting participants**.
-- An optional **Timestamp** clock toggle adds local timestamps such as `[YYYY/MM/DD HH:MM:SS]` to new source blocks, using chunk onset rather than recognition completion. It is off by default and never rewrites earlier text.
-- **Shared meeting audio never sends itself or triggers voice commands.** Microphone transcripts keep your configured sending behavior; choose manual sending if you want to review all meeting context first.
-
-Audio availability depends on the browser, operating system, and sharing surface. This is **not a built-in Google Meet or Teams integration**. Capturing meeting audio and sharing the assistant’s voice back into a call require separate setup. Use headphones to reduce feedback, and obtain appropriate participant consent before capturing a meeting. Transcription and AI responses have processing latency; “real-time” does not mean instantaneous or guaranteed accurate.
-
-
----
-
-## 🔎 Discovery keywords / Termos de busca / 搜索关键词
+Restart DSH, then open **DSH Settings → Live Voice** to configure recognition and speech engines.
 
-- **English:** real-time meeting transcription, live meeting transcription, AI questions during meetings, meeting assistant, meeting Q&A, shared audio capture, speech-to-text, text-to-speech, local-first voice assistant, DeepSeek Harness plugin.
-- **Português:** transcrição de reuniões em tempo real, transcrição ao vivo, perguntas à IA durante reuniões, assistente de reuniões, perguntas e respostas sobre reuniões, captura de áudio compartilhado, reconhecimento de fala, síntese de voz, assistente de voz com prioridade local, plugin para DeepSeek Harness.
-- **简体中文:** 实时会议转写、实时语音转文字、会议中向 AI 提问、AI 会议助手、会议问答、共享音频采集、语音识别、语音合成、本地优先语音助手、DeepSeek Harness 插件。
+## Requirements and configuration
 
-## 🤝 Acknowledgments & Community
+- Microphone capture requires browser support, permission, and a secure context (HTTPS or localhost).
+- Recognition and synthesis engines have separate language, platform, and model requirements. See the engine guide before selecting a setup.
+- Meeting transcription uses **Qwen HTTP** or **Whisper HTTP** recognition. Shared-audio availability depends on the browser, system, and sharing surface; obtain appropriate participant consent.
+- Capturing meeting audio and sharing assistant playback require separate setup. This is not a native Google Meet or Teams integration.
+- The optional `dsh-live-voice-debugger` package is not required by the main plugin.
 
-Listening and speaking should work together. A heartfelt thank you to [GooDAnDReaDY](https://github.com/GooDAnDReaDY) for [dsh-voice](https://github.com/GooDAnDReaDY/dsh-voice) and [Alan2Z](https://github.com/Alan2Z) for [dsh-speak](https://github.com/Alan2Z/dsh-speak), which inspired this unified coordinator. [Read the full story](HISTORY.md).
+## Documentation
 
-I use DSH Live Voice for at least 8 hours every day. Feedback, ideas, and contributions are welcome:
-- [Open an Issue](https://github.com/victorwads/dsh-live-voice/issues)
-- [Send a Pull Request](https://github.com/victorwads/dsh-live-voice/pulls)
+- [Project overview](https://github.com/victorwads/dsh-live-voice#readme) — canonical presentation, screenshots, and use cases.
+- [Configuration and conversation flow](https://github.com/victorwads/dsh-live-voice/blob/main/docs/CONFIGURATION.md)
+- [Speech recognition engine selection](https://github.com/victorwads/dsh-live-voice/blob/main/docs/CHOOSING-AN-ENGINE.md)
+- [Architecture](https://github.com/victorwads/dsh-live-voice/blob/main/docs/ARCHITECTURE.md)
+- [Release notes](https://github.com/victorwads/dsh-live-voice/blob/main/CHANGELOG.md)
+- [Issue tracker](https://github.com/victorwads/dsh-live-voice/issues)
 
----
+## License
 
-### 📄 License [Apache-2.0](LICENSE)
+[Apache-2.0](https://github.com/victorwads/dsh-live-voice/blob/main/LICENSE)