Skip to content

Commit af6e27d

Browse files
committed
docs: update README with version 2.0.0 and new configuration options
- Add language selection for AI summaries - Include summary length controls (short, medium, long) - Update AI model list with latest versions and pricing - Add temperature and max tokens settings - Enhance theme customization with 20+ themes and font options - Add right-click context menu and date/time format settings - Remove screenshots section and update links BREAKING CHANGE: Version updated to 2.0.0 with new features requiring user configuration updates
1 parent 88cdad4 commit af6e27d

File tree

1 file changed

+84
-30
lines changed

1 file changed

+84
-30
lines changed

README.md

Lines changed: 84 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# AI Summary
22

33
[![CI](https://github.com/lassestilvang/ai-summary-extension/workflows/CI/badge.svg)](https://github.com/lassestilvang/ai-summary-extension/actions)
4-
[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/lassestilvang/ai-summary-extension)
4+
[![Version](https://img.shields.io/badge/version-2.0.0-blue.svg)](https://github.com/lassestilvang/ai-summary-extension)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66

77
![SCR-20250925-porj-2](https://github.com/user-attachments/assets/19f33ad3-419b-4ce1-9752-3fd0817c9402)
@@ -17,7 +17,6 @@
1717
- [Configuration Options](#configuration-options)
1818
- [Keyboard Shortcuts](#keyboard-shortcuts)
1919
- [Troubleshooting Tips](#troubleshooting-tips)
20-
- [Screenshots](#screenshots)
2120
- [Contribution Guidelines](#contribution-guidelines)
2221
- [License Information](#license-information)
2322
- [Acknowledgments](#acknowledgments)
@@ -195,29 +194,83 @@ The extension uses `chrome.storage.sync` for persistent settings:
195194

196195
## Configuration Options
197196

197+
### Language Selection
198+
199+
Choose the language for AI-generated summaries:
200+
201+
- English (default)
202+
- Spanish
203+
- French
204+
- German
205+
- Italian
206+
- Portuguese
207+
- Chinese
208+
- Japanese
209+
- Korean
210+
- Russian
211+
- Arabic
212+
- Hindi
213+
- Danish
214+
- Norwegian
215+
- Swedish
216+
- Finnish
217+
- Polish
218+
- Ukrainian
219+
- Dutch
220+
221+
### Summary Length
222+
223+
Control the length of generated summaries:
224+
225+
- **Short**: Brief, concise summaries
226+
- **Medium**: Balanced length summaries (default)
227+
- **Long**: Detailed, comprehensive summaries
228+
198229
### AI Model Selection
199230

200231
Choose from various AI models with different capabilities and costs:
201232

202233
- **Free Models**:
203-
- Chrome Built-in AI (Free)
234+
- Chrome Built-in AI (Free, requires Chrome 138+)
204235
- Gemini 2.0 Flash Experimental (Free)
205236

206237
- **OpenAI Models**:
207238
- GPT-3.5 Turbo ($0.002/1K tokens)
208239
- GPT-4 ($0.03/1K tokens)
209240
- GPT-4 Turbo ($0.01/1K tokens)
210241
- GPT-4o ($0.005/1K tokens)
242+
- GPT-5 ($0.00125/1K tokens)
243+
- GPT-5 mini ($0.00025/1K tokens)
244+
- GPT-5 nano ($0.00005/1K tokens)
211245

212246
- **Google Gemini Models**:
213-
- Gemini 1.5 Pro ($0.00125/1K tokens)
214-
- Gemini 1.5 Flash ($0.000075/1K tokens)
247+
- Gemini 2.5 Pro ($0.00125/1K tokens)
248+
- Gemini 2.5 Flash ($0.00003/1K tokens)
215249

216250
- **Anthropic Claude Models**:
217251
- Claude 3 Haiku ($0.00025/1K tokens)
218252
- Claude 3 Sonnet ($0.003/1K tokens)
219253
- Claude 3 Opus ($0.015/1K tokens)
220254
- Claude 3.5 Sonnet ($0.003/1K tokens)
255+
- Claude 4.5 Sonnet ($0.003/1K tokens)
256+
- Claude 4.5 Haiku ($0.001/1K tokens)
257+
258+
### Temperature
259+
260+
Adjust the creativity/randomness of AI responses:
261+
262+
- Range: 0.0 to 2.0
263+
- Default: 0.7
264+
- Lower values (0.0-0.5): More focused and deterministic
265+
- Higher values (1.0-2.0): More creative and varied
266+
267+
### Max Tokens
268+
269+
Set the maximum length of AI responses:
270+
271+
- Range: 100 to 4000 tokens
272+
- Default: 1000 tokens
273+
- Higher values allow longer summaries but may increase costs
221274

222275
### Fallback Settings
223276

@@ -227,12 +280,34 @@ Choose from various AI models with different capabilities and costs:
227280
### API Keys
228281

229282
- Securely store API keys for paid AI services
230-
- Keys are encrypted and stored locally
283+
- Keys are encrypted and stored locally using Chrome's storage API
284+
- Real-time validation with visual indicators
285+
- Required for OpenAI, Google Gemini, and Anthropic models
286+
287+
### Theme Customization
288+
289+
- Choose from 20+ available themes to customize the UI appearance
290+
- Customize font family, size (8-24px), and style
291+
- Real-time preview of theme changes
292+
- Available themes include: Light, Dark, Solarized, Nord, Autumn, Synthwave, and many more
293+
294+
### Extension Settings
295+
296+
#### Right-Click Context Menu
297+
298+
- Enable/disable right-click context menu for selected text
299+
- When enabled, right-clicking on selected text shows an option to summarize it
300+
- Default: Enabled
301+
302+
#### Date and Time Format
231303

232-
### Theme Selection
304+
Choose how dates and times are displayed in the extension:
233305

234-
- Choose from available themes to customize the UI appearance
235-
- Themes are defined in `themes.js`
306+
- DD/MM/YYYY HH:MM (24-hour) - 17/10/2024 20:21
307+
- MM/DD/YYYY HH:MM (12-hour) - 10/17/2024 08:21 PM
308+
- YYYY-MM-DD HH:MM (24-hour) - 2024-10-17 20:21
309+
- DD.MM.YYYY HH:MM (24-hour) - 17.10.2024 20:21
310+
- MM-DD-YYYY HH:MM (12-hour) - 10-17-2024 08:21 PM
236311

237312
## Keyboard Shortcuts
238313

@@ -342,26 +417,6 @@ To reset all settings:
342417
3. Click "Details"
343418
4. Scroll to "Site access" and click "Clear storage"
344419

345-
## Screenshots
346-
347-
### Main Interface
348-
349-
![Extension Popup](screenshots/popup.png)
350-
351-
_The main extension popup showing a page summary_
352-
353-
### Settings Page
354-
355-
![Options Page](screenshots/options.png)
356-
357-
_Configuration options for AI models and API keys_
358-
359-
### Performance Metrics
360-
361-
![Metrics Dashboard](screenshots/metrics.png)
362-
363-
_Model performance tracking and statistics_
364-
365420
## Contribution Guidelines
366421

367422
We welcome contributions! Please follow these guidelines:
@@ -422,7 +477,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
422477

423478
- **Project Homepage**: [https://github.com/lassestilvang/ai-summary-extension](https://github.com/lassestilvang/ai-summary-extension)
424479
- **Issues**: [GitHub Issues](https://github.com/lassestilvang/ai-summary-extension/issues)
425-
- **Discussions**: [GitHub Discussions](https://github.com/lassestilvang/ai-summary-extension/discussions)
426480

427481
---
428482

0 commit comments

Comments
 (0)