diff --git a/README.md b/README.md index 3c54ae58..00c35c82 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,30 @@ [![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/channels/1057273017547378788/1126104260430528613) - -CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR, provides feedback and suggestions, and can answer free-text questions. - +
+ +CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR and can provide several types of feedback: + +**Auto-Description**: Automatically generating PR description - name, type, summary, and code walkthrough. +\ +**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused, and various suggestions for the PR content. +\ +**Question Answering**: Answering free-text questions about the PR. +\ +**Code Suggestion**: Committable code suggestions for improving the PR. + +Example results: +
+
+

+ +

+

+ +

+
+
- [Live demo](#live-demo) - [Overview](#overview) @@ -22,6 +42,7 @@ CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs - [How it works](#how-it-works) - [Roadmap](#roadmap) - [Similar projects](#similar-projects) +
## Live demo diff --git a/pics/Icon-7.png b/pics/Icon-7.png deleted file mode 100644 index 61a9dc6f..00000000 Binary files a/pics/Icon-7.png and /dev/null differ diff --git a/pics/extended_code_suggestion.png b/pics/extended_code_suggestion.png deleted file mode 100644 index 4b82e8fb..00000000 Binary files a/pics/extended_code_suggestion.png and /dev/null differ diff --git a/pics/main_pic_4_tools.gif b/pics/main_pic_4_tools.gif new file mode 100644 index 00000000..8cdbef05 Binary files /dev/null and b/pics/main_pic_4_tools.gif differ diff --git a/pics/pr_auto_description.png b/pics/pr_auto_description.png new file mode 100644 index 00000000..1f3d1859 Binary files /dev/null and b/pics/pr_auto_description.png differ diff --git a/pics/pr_code_suggestions.png b/pics/pr_code_suggestions.png new file mode 100644 index 00000000..b7c86e2e Binary files /dev/null and b/pics/pr_code_suggestions.png differ diff --git a/pics/pr_questions.png b/pics/pr_questions.png index ed86e7bb..7ba11491 100644 Binary files a/pics/pr_questions.png and b/pics/pr_questions.png differ diff --git a/pics/pr_reviewer.png b/pics/pr_reviewer.png deleted file mode 100644 index f1aec948..00000000 Binary files a/pics/pr_reviewer.png and /dev/null differ diff --git a/pics/pr_reviewer_1.png b/pics/pr_reviewer_1.png new file mode 100644 index 00000000..1ae2bad6 Binary files /dev/null and b/pics/pr_reviewer_1.png differ diff --git a/pics/pr_reviewer_2.png b/pics/pr_reviewer_2.png new file mode 100644 index 00000000..6e2fe1c3 Binary files /dev/null and b/pics/pr_reviewer_2.png differ diff --git a/pics/regular_code_suggestion.png b/pics/regular_code_suggestion.png deleted file mode 100644 index 24f97ab8..00000000 Binary files a/pics/regular_code_suggestion.png and /dev/null differ