Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rbx committed Oct 14, 2024
1 parent 9609c57 commit 7c16c21
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,16 @@ Pearbot is an AI assistant that reviews Pull Requests on GitHub and/or local dif
## Prerequisites

- Python 3.9 or higher
- GitHub account (for Pull Request reviews)
- GitHub account (only for Pull Request reviews)
- Ollama or compatible AI model service

Install and run the Ollama AI model service by following the instructions in the [ollama website](https://ollama.com/download).

Install at least one model to use with Pearbot (default of pearbot is `llama3.1`):
```
ollama pull llama3.1
```

## Installation

1. Clone the repository:
Expand All @@ -29,7 +36,7 @@ Pearbot is an AI assistant that reviews Pull Requests on GitHub and/or local dif
pip install .
```

## Configuration
## Configuration (for use as GitHub App)

1. Create a `.env` file in the project root and add the following environment variables:
```
Expand Down

0 comments on commit 7c16c21

Please sign in to comment.