Skip to content

Commit

Permalink
Add screenshot and customization section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aeltorio committed Oct 10, 2024
1 parent bc6f4c3 commit 040fb01
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ This project is an add-in for Outlook web that integrates Groq AI or Sambanova A
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Features](#features)
- [Screenshot](#screenshot)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Customization](#customization)
- [License](#license)
- [Privacy Policy](#privacy-policy)
- [Contributing](#contributing)
Expand Down Expand Up @@ -48,6 +50,7 @@ Before you can use the AI Outlook Add-in, you'll need:

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))
3. For SambaNova AI, obtain an API key from [SambaNova's developer portal](https://console.sambanova.ai) you also need a proxy for bypassing the lack of CORS headers in the sambanova API. You can use our [AI-Proxy-Cloudflare](https://github.com/sctg-development/ai-proxy-cloudflare) for this purpose.

## Installation

Expand Down Expand Up @@ -87,6 +90,11 @@ To set up the development environment:
3. Sign in Office 365: `npm run signin`
4. Start the development server: `npm start`

## Customization

You can customize the AI Outlook Add-in by modifying the `src/config.json` file.
You'll also need to update the `manifest.json` file to reflect your deployment settings.

## License

This project is licensed under the GNU Affero General Public License v3.0 (AGPLv3). For more details, see the [LICENSE](LICENSE.md) file in the project repository.
Expand Down

0 comments on commit 040fb01

Please sign in to comment.