From 3da85209caa4d278d5d612f33cb7dbc7ea526b1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=A6Ltorio?= Date: Sat, 28 Sep 2024 08:30:10 +0200 Subject: [PATCH] Update README.md with Meta Llama model integration and development instructions --- README.md | 54 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bc65407..3ee747e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Groq Outlook Add-in -This project is an add-in for Outlook web that integrates Groq AI capabilities into your email experience. It allows users to leverage the power of Groq's AI in their daily email interactions. +This project is an add-in for Outlook web that integrates Groq AI and Meta Llama model capabilities into your email experience. It allows users to leverage the power of Groq's AI in their daily email interactions. ## Table of Contents + - [Groq Outlook Add-in](#groq-outlook-add-in) - [Table of Contents](#table-of-contents) - [Overview](#overview) @@ -10,6 +11,7 @@ This project is an add-in for Outlook web that integrates Groq AI capabilities i - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) + - [Development](#development) - [License](#license) - [Contributing](#contributing) - [Support](#support) @@ -20,7 +22,7 @@ The Groq Outlook Add-in enhances your email workflow by providing AI-powered ass **Project Repository:** [https://github.com/sctg-development/groq-outlook](https://github.com/sctg-development/groq-outlook) -**Deployed Add-in:** [https://outlook.addin.pp.ua/](https://outlook.addin.pp.ua/) +**Deployed Add-in:** [https://outlook.addin.pp.ua/](https://outlook.addin.pp.ua/manifest.json) ## Features @@ -34,34 +36,46 @@ The Groq Outlook Add-in enhances your email workflow by providing AI-powered ass Before you can use the Groq Outlook Add-in, you'll need: -1. A Microsoft account with access to Outlook on the web +1. Access to your company's Microsoft 365 admin console 2. A Groq AI developer API key (obtain one from [Groq's developer portal](https://console.groq.com)) ## Installation To install the Groq Outlook Add-in, follow these steps: -1. Open Outlook on the web and sign in to your account. -2. Go to Settings (gear icon) > View all Outlook settings. -3. Navigate to Mail > Add-ins. -4. Click on "Add a custom add-in" and select "Add from URL". -5. Enter the following URL for the manifest file: - ``` - https://outlook.addin.pp.ua/manifest.json - ``` -6. Follow the prompts to complete the installation. +1. Download the latest release (nightly) ZIP file from the [project's GitHub releases section](https://github.com/sctg-development/groq-outlook/releases). +2. Log in to your company's Microsoft 365 admin console. +3. Navigate to Settings > Integrated applications. +4. Click on "Load customized applications" (or a similar option for adding custom add-ins). +5. Upload the ZIP file you downloaded in step 1. +6. Follow any additional prompts to complete the installation process. + +Note: The exact steps may vary slightly depending on your organization's Microsoft 365 configuration. If you encounter any issues, please contact your IT administrator for assistance. ## Usage -After installation, to use the Groq Outlook Add-in: +After installation: + +1. Open Outlook on the web and sign in to your account. +2. Open an email or start composing a new message. +3. Look for the Groq Outlook Add-in called **AI emailer** icon in the Outlook ribbon. +4. Click on the icon to open the add-in pane. +5. Enter your Groq AI developer API key when prompted (this is a one-time setup). +6. Use the add-in features as needed in your email workflow: + - For composition assistance, select the text you want to improve and use the relevant feature. + - For email summarization, open the email you want to summarize and use the summarization feature. + - For translation, select the text to translate and choose the target language. + +Refer to the in-app instructions for more detailed usage guidelines. + +## Development -1. Open an email or start composing a new message. -2. Look for the Groq Outlook Add-in icon in the Outlook ribbon. -3. Click on the icon to open the add-in pane. -4. Enter your Groq AI developer API key when prompted (this is a one-time setup). -5. Use the various features of the add-in as needed in your email workflow. +To set up the development environment: -[Note: Please add more specific usage instructions based on the actual features and user interface of your add-in.] +1. Clone the repository: `git clone https://github.com/sctg-development/groq-outlook.git` +2. Install dependencies: `npm install` +3. Sign in Office 365: `npm run signin` +4. Start the development server: `npm start` ## License @@ -83,4 +97,4 @@ If you encounter any issues or have questions about the Groq Outlook Add-in, ple --- -This project is not affiliated with or endorsed by Microsoft or Groq. It is an independent add-in developed to enhance the Outlook web experience using Groq's AI capabilities. +This project is not affiliated with or endorsed by Microsoft, Meta or Groq. It is an independent add-in developed to enhance the Outlook web experience using Groq's AI capabilities and Meta Llama models.