diff --git a/README.md b/README.md index 9146783..301463d 100644 --- a/README.md +++ b/README.md @@ -26,77 +26,58 @@ ## Table of Contents +- [⬇️ Download](#️-download) - [🔮 Overview](#-overview) - [✨ Features](#-features) - [🔰 Tech Stack](#-tech-stack) - [🤗 Contributing](#-contributing) - [🎗 License](#-license) -> [!CAUTION] -> Amical is in active development towards its first release, expect bugs and breaking changes. +## ⬇️ Download + +

+ + Download for macOS + + + Download for Windows + +

## 🔮 Overview -Open source AI Dictation and Note-taking\ -Dictate hands-free, transcribe meetings, and capture notes effortlessly - powered by Gen AI +Local-first AI Dictation app. + +Amical is an open source AI-powered dictation and note-taking app that runs entirely on your machine. +Powered by [Whisper](https://github.com/openai/whisper) for speech-to-text and open source LLMs for intelligent processing, Amical gives you the power of AI dictation with complete privacy. + +Context-aware dictation that adapts to what you're doing: drafting an email, chatting on Discord, writing prompts in your IDE, or messaging friends. Amical detects the active app and formats your speech accordingly. + ## ✨ Features > ✔︎ - Done, ◑ - In Progress, ◯ - Planned -### 📱 Apps +🚀 Super-fast dictation with AI-enhanced accuracy ✔︎ -◑ `Mac` -◯ `Windows` -◯ `Linux` -◯ `iOS` -◯ `Android` +🧠 Context-aware speech-to-text based on the active app ✔︎ -### ⚡ Core Features +📒 Smart voice notes → summaries, tasks, structured notes ◑ -✔︎Context-Awareness\ -Recognize context based on the apps being used in the background to customize transcription based on use case.\ -◑Note Taking\ -Take quick notes with voice within the app.\ -◑Meeting Transcription\ -Record live meetings with both mic and system audio for seamless transcription.\ -◑Automatic Meeting Notes\ -Generate meeting notes using transcriptions and templates\ -◑Custom Hotkeys\ -Configure your own keyboard shortcuts for common transcription actions (start/stop, commands).\ -✔︎Desktop Widget\ -A floating, easily accessible widget to control transcription without leaving your workflow.\ -✔︎Multi-Language Support\ -Support for multiple languages and dialects for global usability.\ -✔︎Custom Vocabulary\ -Add custom terms, such as names, technical terms, or slang, for better accuracy.\ -◯Automatic Vocabulary\ -Dynamically learn new words based on usage.\ -◑Bring Your Own Key\ -Use your own API keys for AI models within the app.\ -✔︎Bring Your Own Model (Ollama)\ -Point to any AI model within the app. +🔌 MCP integration → voice commands that control your apps ◯ -### 🔗 Integrations & Workflow +🎙️ Real-time meeting transcription (mic + system audio) ◯ -◯MCP Integrations\ -Seamlessly integrate your apps via MCP for control and command.\ -◯Voice Commands\ -Control desktop apps and transcription processes via native and custom integrations.\ -◯Integration Framework\ -Framework and devkit to build your own integrations. +🔧 Extensible via hotkeys, voice macros, custom workflows ✔︎ -### 🌟 Enhancements +🔐 Privacy-first: works offline, one click setup of local models in-app ✔︎ -◯Text Editing\ -Inline editing of transcribed text via voice commands.\ -◯Transcription History\ -Maintain an easily searchable history of transcribed texts, with export options.\ -◯Custom Prompts\ -Custom prompts for AI to pre and post-process transcription to support use cases like custom formatting, summaries, etc.\ +🪟 Floating widget for frictionless start/stop with custom hotkeys ✔︎ ## 🔰 Tech Stack +- 🎤 [Whisper](https://github.com/openai/whisper) +- 🦙 [Ollama](https://ollama.ai) - 🧑‍💻 [Typescript](https://www.typescriptlang.org/) - 🖥️ [Electron](https://electronjs.org/) - ☘️ [Next.js](https://nextjs.org/) @@ -116,7 +97,7 @@ Contributions are welcome! Please read the [Contributing Guide][contributing] to - **🐛 [Report an Issue][issues]**: Found a bug? Let us know! - **💬 [Start a Discussion][discussions]**: Have ideas or suggestions? We'd love to hear from you. -# 🎗 License +## 🎗 License Released under [MIT][license].