Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasrump committed Oct 14, 2024
1 parent e97996b commit 887fdcf
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,19 @@ If you want to run the modells locally otherwise you will need the corresponding
pipx install git+https://github.com/lukasrump/crllm.git
```

### Install from PyPI
```sh
pipx install crllm
```

## 🌐 Configuration
CRLLM supports multiple backends for LLM code reviews. You can configure it by adding an configuration file `crllm_config.toml` in the root of your project.
CRLLM supports multiple backends for LLM code reviews. You can configure it by adding an configuration file `crllm_config.toml` in the root of your project. To initialize your project you can use

```bash
crllm -i .
```

This command guides you through the most important settings.
This TOML configuration file is splitted in four main sections:

### [project]
Expand Down

0 comments on commit 887fdcf

Please sign in to comment.