feat: release 1.0 - rename to Hearbit AI, fix timestamps, update UI
This commit is contained in:
michael.borak
112
README.md
112
README.md
@@ -1,74 +1,74 @@
|
||||
# Hearbit AI 🦉🎙️
|
||||
|
||||
Hearbit AI is a powerful macOS desktop application designed to record system and microphone audio, transcribe it using Infomaniak's Whisper API, and generate intelligent AI summaries.
|
||||
**Hearbit AI** is your professional meeting assistant for macOS. It records both your microphone and system audio (e.g., Teams, Zoom), transcribes it with high precision using Infomaniak's Whisper API, and generates intelligent, structured summaries.
|
||||
|
||||
## Features
|
||||
|
||||
|
||||
* **Dual-Channel Recording**: Capture both your microphone (e.g., for voice notes) and system audio (e.g., for meetings) simultaneously.
|
||||
* **Powered by Infomaniak AI**:
|
||||
* **Transcription**: High-accuracy speech-to-text using Infomaniak's Whisper integration.
|
||||
* **Summarization**: Generate concise summaries, action items, or meeting notes using models like Mixtral or Llama 3 via Infomaniak's LLM API.
|
||||
* **Auto-Save**: Recordings and summaries are automatically saved to a persistent history.
|
||||
* **Customizable Prompts**: Define your own AI templates (e.g., "Summarize", "Extract Action Items", "Translate").
|
||||
* **Privacy-Focused**: Processed securily via your own Infomaniak API keys.
|
||||
## ✨ Features
|
||||
|
||||
## prerequisites
|
||||
* **🎙️ Dual-Channel Recording**: seamlessly capture your voice and meeting audio from apps like Microsoft Teams, Zoom, or Google Meet.
|
||||
* **🧠 Powered by Infomaniak AI**:
|
||||
* **Precision Transcription**: Standard-compliant formatting with **second-by-second timestamps** (e.g., `[00:12]`).
|
||||
* **Smart Summaries**: Uses advanced LLMs (Mixtral, Llama 3) to create actionable meeting notes.
|
||||
* **📝 Professional Templates**: Comes with 3 built-in expert prompts:
|
||||
* **Meeting Protocol**: For general business meetings.
|
||||
* **1:1 / Jour Fixe**: For confidential personnel discussions.
|
||||
* **Client Meeting**: For official, client-ready documentation.
|
||||
* **💾 Auto-Save**: All recordings and summaries are saved locally to your history.
|
||||
* **🔒 Privacy-First**: Data is processed securely via your own Infomaniak API keys.
|
||||
|
||||
* **macOS** (Apple Silicon or Intel)
|
||||
* **Infomaniak AI Account**: You need an API Key and Product ID from [Infomaniak's Developer Portal](https://manager.infomaniak.com/).
|
||||
---
|
||||
|
||||
## Installation
|
||||
## 🚀 Getting Started
|
||||
|
||||
1. Download the latest release (`.dmg` or `.app`).
|
||||
## Recording System Audio (Teams, Zoom, etc.)
|
||||
### 1. Prerequisites
|
||||
* **macOS** (Apple Silicon or Intel).
|
||||
* **Infomaniak AI Account**: You need an API Key and Product ID from the [Infomaniak Developer Portal](https://manager.infomaniak.com/).
|
||||
|
||||
To record meetings from apps like Microsoft Teams, Zoom, or Google Meet, you need to route the computer's audio into Hearbit AI. This requires **BlackHole 2ch**.
|
||||
### 2. Installation
|
||||
1. Download the latest `.dmg` file from the [Releases page](#).
|
||||
2. Open the `.dmg` and drag **Hearbit AI** to your Applications folder.
|
||||
3. Launch the app.
|
||||
|
||||
### 1. Install BlackHole
|
||||
1. Download and install [BlackHole 2ch](https://existential.audio/blackhole/).
|
||||
2. Restart your computer if required.
|
||||
---
|
||||
|
||||
### 2. Create a Multi-Output Device (To hear audio while recording)
|
||||
1. Open **Audio MIDI Setup** (search in Spotlight).
|
||||
2. Click the `+` icon and select **Create Multi-Output Device**.
|
||||
3. Check **BlackHole 2ch** AND **MacBook Pro Speakers** (or your headphones).
|
||||
4. Set "Master Device" to **BlackHole 2ch**.
|
||||
|
||||
|
||||
## 🎧 Recording System Audio (Teams, Zoom, etc.)
|
||||
|
||||
### 3. Create an Aggregate Device (For Hearbit AI Input)
|
||||
1. In Audio MIDI Setup, click `+` and select **Create Aggregate Device**.
|
||||
2. Name it "Hearbit-AI" (or similar).
|
||||
3. Check **BlackHole 2ch** AND **MacBook Pro Microphone**.
|
||||
4. Ensure "Drift Correction" is enabled for the Microphone.
|
||||
To record clear meeting audio from other applications, you need a "virtual cable". We recommend **BlackHole 2ch**.
|
||||
|
||||
|
||||
1. **Install BlackHole**: Download and install [BlackHole 2ch](https://existential.audio/blackhole/).
|
||||
2. **Create a Multi-Output Device** (So you can hear the audio too!):
|
||||
* Open **Audio MIDI Setup** on your Mac.
|
||||
* Create a "Multi-Output Device".
|
||||
* Select both **BlackHole 2ch** AND your **Headphones/Speakers**.
|
||||
* *Tip: Use this Multi-Output Device as your SPEAKER in Teams/Zoom.*
|
||||
3. **Select Input in Hearbit AI**:
|
||||
* In Hearbit AI, select **BlackHole 2ch** (or an Aggregate Device combining your Mic + BlackHole) as the **Input Device**.
|
||||
|
||||
### 4. Setup in Hearbit AI
|
||||
1. Open **Hearbit AI**.
|
||||
2. In the **Input Device** dropdown, select your Aggregate Device (e.g., "Hearbit-AI").
|
||||
3. Start Recording.
|
||||
---
|
||||
|
||||
### 5. Setup in Teams/Zoom
|
||||
* Set your **Speaker** output in Teams/Zoom to the **Multi-Output Device** you created in Step 2.
|
||||
## 🛠️ Usage Guide
|
||||
|
||||
1. **Configure**:
|
||||
* Click the **Settings** (gear icon) in the top right.
|
||||
1. **Configuration**:
|
||||
* Click the **Settings** (gear icon).
|
||||
* Enter your **Infomaniak API Key** and **Product ID**.
|
||||
* (Optional) Customize your AI prompts.
|
||||
2. **Record**:
|
||||
* Select your **Input Device** (e.g., "MacBook Pro Microphone" or an aggregate device for system audio).
|
||||
* Select an **LLM Model** (e.g., Mixtral).
|
||||
* (Optional) Customize where recordings are saved.
|
||||
|
||||
2. **Recording**:
|
||||
* Choose your **Template** (e.g., "Meeting Protocol").
|
||||
* Select your **Input Device**.
|
||||
* Click **Start Recording**.
|
||||
3. **Process**:
|
||||
* Click **Stop Recording**.
|
||||
* The app will automatically upload, transcribe, and summarize your audio.
|
||||
4. **History**:
|
||||
* Click **Records** to view past recordings.
|
||||
|
||||
## Development
|
||||
3. **Processing**:
|
||||
* Click **Stop** when finished.
|
||||
* The app will transcribe the audio (with timestamps!) and generate a summary based on your selected template.
|
||||
* You will be automatically taken to the **Transcription** tab to review the results.
|
||||
|
||||
This app is built with **Tauri**, **React**, and **TypeScript**.
|
||||
---
|
||||
|
||||
## 👨💻 Development
|
||||
|
||||
Built with **Tauri**, **React**, and **TypeScript**.
|
||||
|
||||
### Setup
|
||||
```bash
|
||||
@@ -77,8 +77,6 @@ npm install
|
||||
|
||||
### Run Locally
|
||||
```bash
|
||||
npm run dev
|
||||
# OR
|
||||
npm run tauri dev
|
||||
```
|
||||
|
||||
@@ -86,9 +84,9 @@ npm run tauri dev
|
||||
```bash
|
||||
npm run tauri build
|
||||
```
|
||||
*The build artifact will be located in `src-tauri/target/release/bundle/dmg/*`*
|
||||
|
||||
## Icons
|
||||
The app uses a custom generated icon set located in `src-tauri/icons`.
|
||||
---
|
||||
|
||||
## License
|
||||
[License Name]
|
||||
## 📄 License
|
||||
Property of Livtec. All rights reserved.
|
||||
|
||||
Reference in New Issue
Block a user