From 887fdcf76779ebd9d707b7518c7724ce4613a7e6 Mon Sep 17 00:00:00 2001 From: Lukas Rump Date: Mon, 14 Oct 2024 16:03:20 +0200 Subject: [PATCH] docs: update readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a40834..ff8f06c 100644 --- a/README.md +++ b/README.md @@ -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]