Skip to content

Commit 32f292e

Browse files
committed
updated readme
1 parent 9ae82fc commit 32f292e

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,67 @@
22

33
This project is an extension using Azure Functions and JavaScript. It consists of a backend service that processes speech and text using various Azure AI services and a frontend web application.
44

5+
# Project Overview
6+
7+
## 📌 Overview
8+
9+
**BetterPrompt** is a smart Chrome extension built to enhance digital communication by making user input clearer, more concise, and contextually accurate—whether you're typing, speaking, or on the move. Designed for ease of use and accessibility, BetterPrompt empowers users from all backgrounds, including non-native speakers and individuals with writing disabilities, to communicate more effectively across any website.
10+
11+
Built with **React** and **Material-UI (MUI)** for a sleek, responsive interface, and powered by **Azure Cognitive Services**, the extension provides real-time grammar correction, translation, speech-to-text input, and prompt optimization. BetterPrompt integrates directly into text input fields on any webpage and improves both the quality of search queries and AI interactions—helping users get better results, faster.
12+
13+
---
14+
15+
## 🧠 Key Capabilities
16+
17+
- **Grammar & Clarity Enhancements:** Real-time grammar correction and sentence restructuring.
18+
19+
- **Prompt Optimization:** Refines prompts for search engines and AI tools like ChatGPT.
20+
21+
- **Speech-to-Text Input:** Enables hands-free communication through Azure Speech.
22+
23+
- **Language Translation:** Accurately translates input to and from multiple languages.
24+
25+
- **Content Moderation:** Flags harmful, biased, or sensitive content and suggests ethical alternatives.
26+
27+
- **Accessible UI:** Clean, responsive React + MUI interface that overlays any text field on a webpage.
28+
---
29+
30+
## 🎯 Goals
31+
- Help users communicate clearly, quickly, and effectively—regardless of language fluency or ability.
32+
33+
- Make digital spaces more accessible to users with writing or speech-related disabilities.
34+
35+
- Support global, multilingual communication with accurate translation and optimization.
36+
37+
- Improve the quality of user inputs for AI interactions and search results.
38+
39+
- Promote safe, ethical, and inclusive online communication through intelligent moderation.
40+
41+
---
42+
43+
## 🔭 Vision
44+
45+
BetterPrompt aims to evolve into a universal communication assistant that:
46+
47+
- Integrates with virtual assistants, messaging tools, and productivity platforms.
48+
49+
- Offers tone adjustment, prompt intent detection, and smart writing suggestions.
50+
51+
- Becomes a default accessibility and clarity enhancer for the web and mobile environments.
52+
53+
---
54+
55+
## 🛠 Tech Stack
56+
57+
- **Frontend:** React, Material-UI (MUI)
58+
59+
- **Browser Platform:** Chrome Extension API
60+
61+
- **Speech & Text Processing:** Azure Cognitive Services (Text Analytics, Translator, Speech-to-Text)
62+
63+
- **Backend (Planned):** Azure Functions or Node.js for processing user input
64+
65+
566
## Project Structure
667

768
```

0 commit comments

Comments
 (0)