From 0ac81b19ab0c103a8ac89d4cb5a3a5d8a2a292e5 Mon Sep 17 00:00:00 2001 From: Naomi Chopra Date: Sat, 10 May 2025 22:43:53 +0530 Subject: [PATCH] docs: Update Readme (#6) --- README.md | 141 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 139 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d736738..a3bad49 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,140 @@ -# Amical + +
+ + + + Amical + +
-Open Source Speech-to-Text App powered by Gen AI +

+ + 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 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 keyboard needed. Fast, Accurate, Context-aware and Private. + +## ✨ Features +> ✔︎ - Done, ◑ - In Progress, ◯ - Planned +### Apps + +◑ Mac +◯ Windows +◯ Linux +◯ iOS +◯ Android + +### Core Features + +◑ Context-Awareness +Recognize context based on the apps being used in the background to customize transcription based on use case. + +◑ 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. + +◯ Audio/Video Transcription +Transcribe uploaded audio and video files into text. + +◯ 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 +Point to any AI model within the app. + +### Integrations & Workflow + +◯ 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. + +### Enhancements + +◯ Text Editing +Inline editing of transcribed text via voice commands. + +◯ Transcription History +Maintain an easily searchable history of transcribed texts, with export options. + +◯ Note Taking +Take quick notes with voice within the app. + +◯ Custom Prompts +Custom prompts for AI to pre and post-process transcription to support use cases like custom formatting, summaries, etc. + +◯ Meeting Transcription +Record live meetings with both mic and system audio for seamless transcription. + +## 🔰 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