Skip to content

Commit 2dc20f5

Browse files
committed
docs: Update README with feedback feature documentation
1 parent de11187 commit 2dc20f5

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@
3232

3333
See CodeTranslateAI work seamlessly on any webpage. Select code, and the translated version appears right beside it in a clean, tabbed interface with syntax highlighting.
3434

35+
### 🎯 Key Features
36+
37+
-**Real-time Code Translation** - Translate code snippets instantly with AI
38+
-**14+ Programming Languages** - Support for C, C++, C#, Java, Python, JavaScript, TypeScript, Go, Rust, Swift, Kotlin, PHP, Ruby, Visual Basic
39+
-**Syntax Highlighting** - Beautiful code display with Prism.js
40+
-**Dark/Light Mode** - Seamless theme switching
41+
-**Tabbed Interface** - View multiple translations in tabs
42+
-**One-Click Copy** - Copy translated code to clipboard
43+
-**👍👎 User Feedback** - Rate translation quality and help improve AI (NEW!)
44+
-**Cached Translations** - Faster loading with smart caching
45+
3546
## ![CodeTranslateAI in action](/promotional/Extension%2001.png)
3647

3748
## ![CodeTranslateAI in action](/promotional/Extension%2002.png)
@@ -113,6 +124,24 @@ You must have **Node.js** and **npm** installed on your machine.
113124

114125
- After deployment, **copy the URL** that Wrangler provides.
115126

127+
7. **Set Up Feedback Storage (Optional)**
128+
129+
- For the user feedback feature, create a KV namespace to store feedback data:
130+
131+
<!-- end list -->
132+
133+
```sh
134+
npx wrangler kv:namespace create "FEEDBACK_STORE"
135+
npx wrangler kv:namespace create "FEEDBACK_STORE" --preview
136+
```
137+
138+
- Update the KV namespace IDs in `wrangler.jsonc`:
139+
- Replace `<your_feedback_kv_id>` with the production namespace ID
140+
- Replace `<your_feedback_preview_kv_id>` with the preview namespace ID
141+
- Redeploy the worker: `npx wrangler deploy`
142+
143+
For more details, see [FEEDBACK_FEATURE.md](FEEDBACK_FEATURE.md).
144+
116145
### 🖥️ Part 2: Frontend Setup (Chrome Extension)
117146

118147
1. **Navigate to the Frontend Directory**
@@ -207,6 +236,20 @@ The **CodeTranslateAI** icon should now appear in your Chrome toolbar\!
207236
4. Your cursor will change to a crosshair. Click on any code block on a webpage.
208237
5. A "Translating..." message will appear, followed by the translated code in a new UI.
209238
239+
### 👍👎 Providing Feedback
240+
241+
Help us improve translation quality by rating the AI-generated code:
242+
243+
- Click **👍** if the translation is good
244+
- Click **👎** if the translation needs improvement
245+
- A modal will appear asking what was wrong
246+
- Optionally provide detailed feedback
247+
- Your feedback helps us improve the AI prompts
248+
249+
**All feedback is stored securely and used solely to enhance translation quality.**
250+
251+
For more details about the feedback feature, see [FEEDBACK_FEATURE.md](FEEDBACK_FEATURE.md).
252+
210253
---
211254
212255
## 🐛 Debugging the Backend

0 commit comments

Comments
 (0)