From 2e024e355096ff4fe09a8f5522db6a118b224d2a Mon Sep 17 00:00:00 2001 From: Bogdan Stanga Date: Fri, 22 Nov 2024 12:54:38 +0200 Subject: [PATCH] update readme --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 98dab47..458d60a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,26 @@ -# Presubmit - AI Code Reviewer +
+

+ Presubmit - AI Code Reviewer +

+ +

Context-aware, intelligent and instant PR reviews

[![GitHub last commit](https://img.shields.io/github/last-commit/presubmit/ai-reviewer)](https://github.com/presubmit/ai-reviewer/commits) [![GitHub Stars](https://img.shields.io/github/stars/presubmit/ai-reviewer?style=social)](https://github.com/presubmit/ai-reviewer/stargazers) [![GitHub License](https://img.shields.io/github/license/presubmit/ai-reviewer?color=yellow)](https://github.com/presubmit/ai-reviewer/blob/main/LICENSE) [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/presubmitai?style=social)](https://x.com/intent/follow?screen_name=presubmitai) -> 🤝 **Note**: Presubmit is designed to complement human reviewers, not replace them. It helps catch security issues and bugs early on while also providing context about the overall change, making the human review process more efficient. +
+ +Transform your code review process with Presubmit's AI Code Reviewer that catches bugs, suggests improvements, and provides meaningful summary - all before human reviewers take their first look. -AI code review assistant that helps teams streamline their review process by providing preliminary feedback on pull requests. It acts as a first-pass reviewer, highlighting potential issues and providing context - empowering human reviewers to focus on architectural decisions and complex logic rather than catching basic issues. +- 🔍 **Instant, In-depth PR Analysis**: Catches bugs, security issues, and optimization opportunities in real-time +- 🎯 **Focus on What Matters**: Let AI handle the basics while humans focus on architecture and complex logic +- ⚡ **Lightning-Fast Setup**: Up and running in 2 minutes with GitHub Actions +- 💬 **Interactive & Smart**: Responds to questions and generates code suggestions right in your PR +- ✨ **Title and description generation**: Save time by having the AI generate meaningful title and description for your PR -- 📝 **Line-by-Line Review**: Detailed line-by-line comments, catching bugs, suggesting improvements, and explaining complex changes -- 📊 **Smart Summaries**: Concise summaries of changes that help reviewers understand PR impact -- 💬 **Interactive**: Responds to questions and requests in PR comments -- ⚡ **Time-Saving**: Catches bugs early, letting reviewers to focus on more complex design +> 🤝 **Note**: Presubmit is designed to complement human reviewers, not replace them. It helps catch security issues and bugs early on while also providing context about the overall change, making the human review process more efficient. ![review example](https://github.com/presubmit/ai-reviewer/blob/main/assets/review_example.png?raw=true)