Skip to content

Commit 6f1e967

Browse files
committed
feat: Update extension's README
1 parent fe637cd commit 6f1e967

File tree

1 file changed

+8
-22
lines changed

1 file changed

+8
-22
lines changed

apps/browser-extension/README.md

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,15 @@
1-
# Welcome to roast.dev Beta! 🔥
1+
# Welcome to 🔥 Roast!
22

3-
Thanks for trying out our beta! The official version will be available in Chrome Web Store in November 2024, but until then, let's get you set up with early access.
3+
Thanks for trying out our beta! The stable version will be available in December 2024, but until then, let's get you set up with early access.
44

55
## Quick Install Guide
66

7-
### 1. Unpack & Prepare 📦
7+
### 1. Install the extension from Chrome Web Store
88

9-
- Unzip this package somewhere on your computer
10-
- Keep the folder (your extension needs it)
9+
- Install the extension
10+
- After successful installation pin the extension to your favourites to have instant access to roasting!
1111

12-
### 2. Chrome Developer Mode 🕵️
13-
14-
1. Go to `chrome://extensions`
15-
2. Enable "Developer mode" (top right toggle)
16-
3. Click "Load unpacked"
17-
4. Select the folder you just unpacked
18-
5. Pin roast.dev to your toolbar (click the puzzle piece if you don't see it)
19-
20-
### 3. Start Roasting! 🚀
12+
### 2. Start Roasting! 🚀
2113

2214
1. Click the roast.dev icon
2315
2. Add your LLM API key (ChatGPT, Claude, or Gemini) in the settings
@@ -26,9 +18,7 @@ Thanks for trying out our beta! The official version will be available in Chrome
2618

2719
## Good to Know
2820

29-
- Beta version needs manual reinstall after Chrome restarts
30-
- Your API key and preferences are stored locally, roast doesn't store any code or keys.
31-
- Same features as the upcoming store version
21+
- Your API key and preferences are stored locally, Roast doesn't store any code or keys outside of your browser
3222
- Works with any GitHub PR you can access in your browser
3323

3424
## Need Help?
@@ -38,11 +28,7 @@ Having trouble? Reach out:
3828
3929
- LinkedIn: https://linkedin.com/in/aleksander-grygier
4030

41-
## Coming Soon
42-
43-
The official Chrome Web Store version arrives in November 2024 with auto-updates and seamless installation. Consider this beta your exclusive early access – help me polish the experience while getting your code roasted!
44-
45-
Happy coding (and better PRs after roasting 🧯)!
31+
Happy coding (and better PRs after roasting 🔥)!
4632

4733
---
4834

0 commit comments

Comments
 (0)