Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bogdan Stanga committed Nov 22, 2024
1 parent 0d443b4 commit 9005c5f
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@ Optimize your code review process with Presubmit's AI Code Reviewer that catches
<br/>

## Example
## See it in Action

See example [Pull Request review](https://github.com/presubmit/ebank-backend/pull/13).
> 💡 [View full example PR review](https://github.com/presubmit/ebank-backend/pull/13)
<br />
<div align="center">
<a href="https://github.com/presubmit/ebank-backend/pull/13">
<img src="https://github.com/presubmit/ai-reviewer/blob/main/assets/review_example_3.png?raw=true" alt="AI Code Review example" width="800"/>
</a>
</div>

![AI Code Review example](https://github.com/presubmit/ai-reviewer/blob/main/assets/review_example_3.png?raw=true)
<br/>

## Usage

Expand Down Expand Up @@ -83,6 +87,8 @@ The action requires:
- `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) and matches the `LLM_API_KEY`.

<br/>

## Features

### 🤖 Smart Reviews
Expand Down

0 comments on commit 9005c5f

Please sign in to comment.