diff --git a/README.md b/README.md index 0ee113a8..a4cacda2 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,12 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing - [Getting Started](#getting-started) - [News and Updates](#news-and-updates) -- [Overview](#overview) +- [Why Use PR-Agent?](#why-use-pr-agent) +- [Features](#features) - [See It in Action](#see-it-in-action) - [Try It Now](#try-it-now) - [Qodo Merge 💎](#qodo-merge-) - [How It Works](#how-it-works) -- [Why Use PR-Agent?](#why-use-pr-agent) - [Data Privacy](#data-privacy) - [Contributing](#contributing) - [Links](#links) @@ -60,8 +60,9 @@ Run PR-Agent locally on your repository via command line: [Local CLI setup guide ### Qodo Merge as post-commit in your local IDE See [here](https://github.com/qodo-ai/agents/tree/main/agents/qodo-merge-post-commit) -### Discover Qodo Merge 💎 +### Discover Qodo Merge 💎 Zero-setup hosted solution with advanced features and priority support +- **[FREE for Open Source](https://github.com/marketplace/qodo-merge-pro-for-open-source)**: Full features, zero cost for public repos - [Intro and Installation guide](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) - [Plans & Pricing](https://www.qodo.ai/pricing/) @@ -101,11 +102,22 @@ New tool for Qodo Merge 💎 - `/scan_repo_discussions`. Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/). -## Overview +## Why Use PR-Agent? + +A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"` + +Here are some advantages of PR-Agent: + +- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single LLM call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably. +- Our [PR Compression strategy](https://qodo-merge-docs.qodo.ai/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs. +- Our JSON prompting strategy enables us to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible. +- We support **multiple git providers** (GitHub, GitLab, BitBucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT, Claude, Deepseek, ...) + +## Features