Skip to content

Commit

Permalink
feat: Update the readme w/ screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
kmesiab committed Jan 17, 2024
1 parent ad6cde2 commit 040c9eb
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,23 @@ languages.
- **AI-Powered Insights**: Employs ChatGPT for in-depth code analysis.
- **User-Friendly CLI**: Simple and intuitive command-line interface
for easy usage.
- **Markdown Reports**: Outputs code reviews in markdown for flexible viewing and integration.

![Screenshot](./assets/cadre-screenshot.png)

## Review Details

Each diff file is reviewed in isolation. Code reviews are broken into several sections:

- Technical Accuracy
- Best Practices
- Performance and Scalability
- Readability and Clarity
- Maintainability
- Testability
- Contextual Fit

![Screenshot](./assets/cadre-best-practices-screenshot.png)

## Installation 🔧

Expand Down Expand Up @@ -48,7 +65,7 @@ export IGNORE_FILES=.mod,.sum
To run the program:

```bash
cadre
cadre --url [url to github pull request]
```

## Usage 💡
Expand Down
Binary file added assets/cadre-best-practices-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/cadre-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/cadre-self-review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 040c9eb

Please sign in to comment.