From 7459226b8db00c534ae3b838dc2eca1e241c94b0 Mon Sep 17 00:00:00 2001 From: Naomi Chopra Date: Sat, 10 May 2025 20:01:23 +0530 Subject: [PATCH 1/2] init readme --- README.md | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 135 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d736738..b03f59a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,137 @@ -# Amical + +
+ + + + Amical + +
+ +

+ + PRs Welcome + + + license + +
+ + discord + +

+ +

+ Website - Docs - Community - Bug reports +

+ +## Table of Contents + +- [🔮 Overview](#-overview) +- [✨ Features](#-features) +- [🔰 Tech Stack](#-tech-stack) +- [🤗 Contributing](#-contributing) +- [🎗 License](#-license) + +> [!CAUTION] +> Amical is still in alpha, expect bugs and breaking changes. + +## 🔮 Overview Open Source Speech-to-Text App powered by Gen AI +Type 10x faster, no keyboards needed. Fast, Accurate, Context-aware and Private. + +## ✨ Features + +### 🖥️ Apps + +📅 Windows +🔄 Mac +📅 Linux +📅 iOS +📅 Android + +### ⚡ Core Features + +🔄 Audio/Video Transcription +Transcribe both audio and video files into text seamlessly. + +🔄 Context-Awareness +Recognize and maintain context across long transcription sessions. + +🔄 Custom Hotkeys +Configure your own keyboard shortcuts for common transcription actions (start/stop, pause). + +🔄 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. + +📅 Meeting Recording +Record live meetings or conferences with both mic and system audio. + +📅 Custom Vocabulary +Add custom terms, such as product names, technical terms, or slang, for better accuracy. + +📅 Automatic Vocabulary +Dynamically learn new words based on user input and usage. + +📅 Bring Your Own Model +Easily plug in your own custom or third-party ASR model for transcription. + +📅 Bring Your Own Key +Integrate with third-party ASR models by using your own API key (e.g., OpenAI, Azure). + +📅 Voice Commands +Control desktop apps and transcription processes via native voice commands and MCP integrations. + +### 🔗 Integrations & Workflow + +📅 MCP Integrations +Seamlessly integrate with collaboration tools like Slack, Teams, or Notion for real-time workflow. + +### 🌟 Enhancements + +📅 Text Editing +Inline editing with full support for timestamps, formatting, and searching within transcripts. + +📅 Transcription History +Maintain an easily searchable history of transcribed texts, with export options (CSV, DOCX, PDF). + +📅 Note Taking +Add notes, tags, or highlight sections of your transcriptions for better organization. + +📅 Custom Prompts +Pre-define prompts for AI to generate summaries, action items, or other insights directly from transcripts. + +## 🔰 Tech Stack + +- 🧑‍💻 [Typescript](https://www.typescriptlang.org/) +- 🖥️ [Electron](https://electronjs.org/) +- ☘️ [Next.js](https://nextjs.org/) +- 🎨 [TailwindCSS](https://tailwindcss.com/) +- 🧑🏼‍🎨 [Shadcn](https://ui.shadcn.com/) +- 🔒 [Better-Auth](https://better-auth.com/) +- 🧘‍♂️ [Zod](https://zod.dev/) +- 🐞 [Jest](https://jestjs.io/) +- 📚 [Fumadocs](https://github.com/fuma-nama/fumadocs) +- 🌀 [Turborepo](https://turbo.build/) + +## 🤗 Contributing + +Contributions are welcome! Please read the [Contributing Guide][contributing] to get started. + +- **💡 [Contributing Guide][contributing]**: Learn about our contribution process and coding standards. +- **🐛 [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 + +Released under [AGPLv3][license]. + + +[contributing]: https://github.com/amicalhq/amical/blob/main/CONTRIBUTING.md +[license]: https://github.com/amicalhq/amical/blob/main/LICENSE +[discussions]: https://discuss.amical.ai +[issues]: https://github.com/amicalhq/amical/issues +[pulls]: https://github.com/amicalhq/amical/pulls "submit a pull request" \ No newline at end of file From 25ee82b953178d6b69f4c1f0bc7e9dc1c38fecc2 Mon Sep 17 00:00:00 2001 From: Naomi Chopra Date: Sat, 10 May 2025 22:42:36 +0530 Subject: [PATCH 2/2] docs: Update project readme --- README.md | 91 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 47 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index b03f59a..a3bad49 100644 --- a/README.md +++ b/README.md @@ -33,76 +33,79 @@ - [🎗 License](#-license) > [!CAUTION] -> Amical is still in alpha, expect bugs and breaking changes. +> Amical is in active development towards its first release, expect bugs and breaking changes. ## 🔮 Overview -Open Source Speech-to-Text App powered by Gen AI -Type 10x faster, no keyboards needed. Fast, Accurate, Context-aware and Private. +Open Source Speech-to-Text App powered by Gen AI\ +Type 10x faster, no keyboard needed. Fast, Accurate, Context-aware and Private. ## ✨ Features +> ✔︎ - Done, ◑ - In Progress, ◯ - Planned +### Apps -### 🖥️ Apps +◑ Mac +◯ Windows +◯ Linux +◯ iOS +◯ Android -📅 Windows -🔄 Mac -📅 Linux -📅 iOS -📅 Android +### Core Features -### ⚡ Core Features +◑ Context-Awareness +Recognize context based on the apps being used in the background to customize transcription based on use case. -🔄 Audio/Video Transcription -Transcribe both audio and video files into text seamlessly. +◑ Custom Hotkeys +Configure your own keyboard shortcuts for common transcription actions (start/stop, commands). -🔄 Context-Awareness -Recognize and maintain context across long transcription sessions. +◑ Desktop Widget +A floating, easily accessible widget to control transcription without leaving your workflow. -🔄 Custom Hotkeys -Configure your own keyboard shortcuts for common transcription actions (start/stop, pause). +◑ Multi-Language Support +Support for multiple languages and dialects for global usability. -🔄 Desktop Widget -A floating, easily accessible widget to control transcription without leaving your workflow. +◯ Audio/Video Transcription +Transcribe uploaded audio and video files into text. -📅 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. -📅 Meeting Recording -Record live meetings or conferences with both mic and system audio. +◯ Automatic Vocabulary +Dynamically learn new words based on usage. -📅 Custom Vocabulary -Add custom terms, such as product names, technical terms, or slang, for better accuracy. +◯ Bring Your Own Key +Use your own API keys for AI models within the app. -📅 Automatic Vocabulary -Dynamically learn new words based on user input and usage. +◯ Bring Your Own Model +Point to any AI model within the app. -📅 Bring Your Own Model -Easily plug in your own custom or third-party ASR model for transcription. +### Integrations & Workflow -📅 Bring Your Own Key -Integrate with third-party ASR models by using your own API key (e.g., OpenAI, Azure). +◯ MCP Integrations +Seamlessly integrate your apps via MCP for control and command. -📅 Voice Commands -Control desktop apps and transcription processes via native voice commands and MCP integrations. +◯ Voice Commands +Control desktop apps and transcription processes via native and custom integrations. -### 🔗 Integrations & Workflow +◯ Integration Framework +Framework and devkit to build your own integrations. -📅 MCP Integrations -Seamlessly integrate with collaboration tools like Slack, Teams, or Notion for real-time workflow. +### Enhancements -### 🌟 Enhancements +◯ Text Editing +Inline editing of transcribed text via voice commands. -📅 Text Editing -Inline editing with full support for timestamps, formatting, and searching within transcripts. +◯ Transcription History +Maintain an easily searchable history of transcribed texts, with export options. -📅 Transcription History -Maintain an easily searchable history of transcribed texts, with export options (CSV, DOCX, PDF). +◯ Note Taking +Take quick notes with voice within the app. -📅 Note Taking -Add notes, tags, or highlight sections of your transcriptions for better organization. +◯ Custom Prompts +Custom prompts for AI to pre and post-process transcription to support use cases like custom formatting, summaries, etc. -📅 Custom Prompts -Pre-define prompts for AI to generate summaries, action items, or other insights directly from transcripts. +◯ Meeting Transcription +Record live meetings with both mic and system audio for seamless transcription. ## 🔰 Tech Stack