From e703efe2ad03916fbe117784d569ac9b63448544 Mon Sep 17 00:00:00 2001 From: yoannchb-pro <71560747+yoannchb-pro@users.noreply.github.com> Date: Wed, 20 Mar 2024 17:27:23 -0400 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9df0b03..6d85f23 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ title="Mortarboard icons created by itim2101 - Flaticon" >Mortarboard icons created by itim2101 - Flaticon @@ -52,13 +52,13 @@ See the [changelog](./CHANGELOG.md) to see every updates ! ## Set up -> NOTE: This extension only works on Chromium-based browsers like Edge, Chrome, etc. Unfortunately, Firefox requires a click on the extension, which is not very discreet. +> NOTE: This extension only works on Chromium-based browsers like Edge, Chrome, etc.

Popup

-Go to "Manage my extensions" on your browser, then click on "Load unpacked extension" and select the "extension" folder. Afterwards, click on the extension icon and enter the ApiKey obtained from [openai api](https://platform.openai.com/api-keys). Finally, select a gpt model (ensure it work with completion api). +Go to "Manage my extensions" on your browser, then click on "Load unpacked extension" and select the "extension" folder. Afterwards, click on the extension icon and enter the ApiKey obtained from [openai api](https://platform.openai.com/api-keys). Finally, select a [gpt model](https://platform.openai.com/docs/models) (ensure it work with completion api). ## Mode @@ -66,7 +66,7 @@ Go to "Manage my extensions" on your browser, then click on "Load unpa Popup

-- Autocomplete: The extension will complete the question for you. +- Autocomplete: The extension will complete the question for you by selecting the correct(s) answer(s). - Clipboard: The response is copied into the clipboard. - Question to answer: The question is converted to the answer and you can click on it to show back the question (or show back the answer).
Question to Answer @@ -77,9 +77,9 @@ Go to "Manage my extensions" on your browser, then click on "Load unpa Popup

-- Api key: the openai api key. +- Api key\*: the [openai api key](https://platform.openai.com/api-keys) from your account (Note you have to put credits by entering a credit card onto your account). +- GPT Model\*: the [gpt model](https://platform.openai.com/docs/models) you want to use. - Code: a code to be more discret for injecting/removing the extension from the page. Simply type your code you entered into the configuration on the keyboard when you are on your moodle quiz and the extension will be inject. If you want to remove the injection just simply type back the code on your keyboard. -- GPT Model: the gpt model you want to use. You can click on the reload button to get the latest version of available gpt model for your account but you need to enter the api key first. - Cursor indication: show a pointer cursor and a hourglass to know when the request is finished. - Title indication: show some informations into the title to know for example if the code have been injected.
![Injected](./assets/title-injected.png) @@ -93,7 +93,7 @@ Go to "Manage my extensions" on your browser, then click on "Load unpa
![Mouseover2](./assets/mouseover2.gif) - Infinite try: click as much as you want on the question (don't forget to reset the question). - Save history: allows you to create a conversation with ChatGPT by saving the previous question with its answer. However, note that it can consume a significant number of tokens. -- Include images (only work with gpt-4): allows you to include the images from the question to be send to the chatgpt api. The quality is reduced to 75% to use less tokens.However, note that it can consume a significant number of tokens. +- Include images (only work with gpt-4): allows you to include the images from the question to be send to the chatgpt api. The quality is reduced to 75% to use less tokens. However, note that it can consume a significant number of tokens.
![Images](./assets/images.gif) ## Internal Features @@ -143,9 +143,9 @@ Table are formated from the question to make it more readable for CHAT-GPT. Exam ![Text](./assets/text.gif) -## What about if the question can't be completed ? +## What about if the question can't be autocompleted ? -To know if the answer has been copied to the clipboard, you can look at the title of the page which will become "Copied to clipboard" for 3 seconds. +To know if the answer has been copied to the clipboard, you can look at the title of the page which will become "Copied to clipboard" for 3 seconds if `Title indication` is on. ![Clipboard](./assets/clipboard.gif)