update readme

README.md

@@ -1,32 +1,20 @@
 # Presubmit - AI Code Reviewer
 
-🤖 An AI-powered code review assistant that helps teams maintain high code quality by providing automated, intelligent feedback on pull requests.
-
-[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/presubmitai?style=social)](https://x.com/intent/follow?screen_name=presubmitai)
 [![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)
 
-![review example](https://github.com/presubmit/ai-reviewer/blob/main/assets/review_example.png?raw=true)
-
-## Features
+> 🤝 **Note**: Presubmit is designed to complement human reviewers, not replace them. It helps catch basic issues early and provides context, making the human review process more efficient and focused on higher-level concerns.
 
-- 🔍 **Intelligent Code Analysis**: Analyzes your pull requests for:
+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.
 
-  - Code correctness and potential bugs
-  - Code style and consistency
-  - Performance improvements
-  - Security concerns
-  - Readability and maintainability
-  - Best practices and design patterns
-  - Spelling errors
-  - Unreachable code
-  - Possible runtime errors
-  - Error handling
+- 📝 **Line-by-Line Review**: Detailed comments on specific code sections, catching bugs, suggesting improvements, and explaining complex changes
+- 📊 **Smart Summaries**: Concise, meaningful summaries of changes that help reviewers quickly understand PR impact
+- 💬 **Interactive Discussions**: Responds to questions and clarifications in PR comments, making reviews more efficient
+- ⚡ **Time-Saving**: Catches common issues early, letting human reviewers focus on what matters most
 
-- 🚀 **Easy Integration**: Works seamlessly with your GitHub workflow
-- ⚡ **Fast Reviews**: Get instant feedback on your code changes
-- 💡 **Actionable Suggestions**: Receives specific, contextual improvement recommendations
-- 🔒 **Security First**: Runs in your GitHub Actions environment, keeping your code secure
+![review example](https://github.com/presubmit/ai-reviewer/blob/main/assets/review_example.png?raw=true)
 
 ## Usage
 
@@ -66,27 +54,50 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
-        with:
-          llm_model: "claude-3-5-sonnet-20241022"
+          LLM_MODEL: "claude-3-5-sonnet-20241022"
 ```
 
 The action requires:
 
 - `GITHUB_TOKEN`: Automatically provided by GitHub Actions
 - `LLM_API_KEY`: Your API key (added in step 1)
-- `llm_model`: Which LLM model to use. Make sure the model is [supported](https://github.com/presubmit/ai-reviewer/blob/main/src/ai.ts).
+- `LLM_MODEL`: Which LLM model to use. Make sure the model is [supported](https://github.com/presubmit/ai-reviewer/blob/main/src/ai.ts) and matches the `LLM_API_KEY`.
+
+## Features
+
+### 🤖 Smart Reviews
+
+- **In-depth Analysis**: Line-by-line review with context-aware suggestions
+- **Auto PR Summary**: Concise, meaningful summaries of changes
+- **Code Quality**: Catches bugs, anti-patterns, and style issues
+- **Interactive**: Responds to questions and clarifications in comments
+
+### 🛡️ Security & Quality
+
+- **Vulnerability Detection**: Catches security issues and leaked secrets
+- **Best Practices**: Enforces coding standards and security guidelines
+- **Performance**: Identifies potential bottlenecks and optimizations
+- **Documentation**: Ensures proper code documentation and clarity
+
+### ⚡ Developer Experience
 
-## Contributing
+- **2-Minute Setup**: Quick integration with GitHub Actions
+- **Smart PR Titles**: Auto-generates descriptive and meaningful titles
+- **Real-time**: Instant feedback on your pull requests
+- **24/7 Available**: Round-the-clock code reviews
 
-We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
+_Production-ready, secure, and ready to review your code!_ 🚀
 
-## License
+## Show Your Support! ⭐
 
-MIT License - see [LICENSE](LICENSE) for details.
+If you find Presubmit helpful in improving the review process:
 
-## Support
+- **Star this repository** to show your support and help others discover it
+- Share your experience by creating a [GitHub Issue](https://github.com/presubmit/ai-reviewer/issues)
+- Follow me on [X/Twitter](https://x.com/bdstanga) for updates
+- Consider [contributing](CONTRIBUTING.md) to make it even better
 
-- 📧 [Email Support](mailto:[email protected])
+Your support motivates us! 🙏
 
 ---