Skip to content

Commit a89f3f3

Browse files
committed
Update version to 0.5.0 and enhance language support
1 parent 1df1a71 commit a89f3f3

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# Quick Abstract
22

3-
43
<p align="center"><img src="icons/icon.png" width="400" height="400" ></p>
54
A Firefox extension that generates a professional abstract and keywords for the current tab's content using the Perplexity AI API.
65

7-
> **Disclaimer**: _This is an alpha version extension created for self-learning purposes. It is not a professional, full-featured extension. Maintenance and updates will be provided as possible during the developer's limited free time._
8-
96
## Features
107
- Fetches the text content of the active tab
118
- Sends the content to the Perplexity API for abstract and keyword generation
129
- Displays the generated abstract and keywords in the extension popup
1310
- Generates an APA citation for the webpage based on the title, author, and publication date
14-
- **New:** Allows copying the generated abstract, keywords, and citation in Markdown, HTML, or plain text format with the click of a button
15-
- Allows customization of API key, model, and temperature through the options page
11+
- Allows copying the generated abstract, keywords, and citation in Markdown, HTML, or plain text format with the click of a button
12+
- Allows customization of API key, model, and temperature through the options page.
13+
- Supports internationalization (i18n) for English, Spanish, and French languages.
14+
- Allows fine-tuning the abstract generation by adjusting the top-p, top-k, max-tokens, frequency-penalty, and presence-penalty parameters.
1615

1716
## Installation from repository
1817

19-
## Installation
18+
### Installation from XPI file (direct download)
2019

2120
Install the latest version of this add-on by clicking the link below, or you can download the latest version from the releases page.
2221

2322
[![Install Add-on](https://img.shields.io/badge/Install-Add--on-brightgreen?style=for-the-badge)](https://github.com/imigueldiaz/firefox-quick-abstract/releases/latest/download/quick_abstract.xpi)
2423

25-
## Installation from source code
24+
### Installation from source code (manual)
25+
2626
1. Clone this repository or download the source code
2727
2. Open Firefox and go to `about:debugging`
2828
3. Click on "This Firefox" in the left sidebar
@@ -43,6 +43,9 @@ The extension uses the following default configuration:
4343
- API Key: 'pplx-xxxxxxxxxxx' (**replace with your own or it won't work**)
4444
- Model: 'sonar-medium-chat'
4545
- Temperature: 1
46+
- All other parameters are _undefined_ by default.
47+
- Please take account that top-k can't be defined at the same time as top-p, and vice versa.
48+
- Same with presence-penalty and frequency-penalty.
4649

4750
You can change these settings on the options page.
4851

@@ -134,7 +137,7 @@ quick-abstract/
134137

135138
## Dependencies
136139

137-
This extension relies on the Perplexity AI API. You need to sign up for an API key at [https://www.perplexity.ai/](https://www.perplexity.ai/) to use this extension.
140+
This extension relies on the Perplexity AI API. You need to sign up for an API key at [https://www.perplexity.ai/](https://www.perplexity.ai/) to use this extension. You can read the API documentation [here](https://docs.perplexity.ai/).
138141

139142
## Internationalization (i18n)
140143

@@ -144,6 +147,8 @@ This extension now supports internationalization, allowing users to interact wit
144147
- Spanish
145148
- French
146149

150+
To add support for more languages, follow the steps outlined in the "Adding New Languages" section below.
151+
147152
### Language Files
148153

149154
The language-specific message files are located in the `_locales` directory, organized by locale code. Each locale directory contains a `messages.json` file that defines the localized strings for that language.

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"manifest_version": 3,
33
"name": "__MSG_extensionName__",
4-
"version": "0.4.9",
4+
"version": "0.5.0",
55
"description": "__MSG_extensionDescription__",
66
"default_locale": "en",
77
"homepage_url": "https://github.com/imigueldiaz/firefox-quick-abstract",

0 commit comments

Comments
 (0)