Skip to content

Commit

Permalink
docs(readme): Update usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin-mesiab authored and kmesiab committed Dec 7, 2023
1 parent 41f8a39 commit 9894f53
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,17 @@ go install github.com/kmesiab/ai-code-critic
To run the program:

```bash
./ai-code-critic -f input.diff
./ai-code-critic
```

## Usage 💡

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

Usage guidelines for effectively utilizing the application will be available
here.
1. Click the "+" button and enter the url to a github pull request.
2. Wait patiently while things happen.
3. The diff will be loaded in the right pane.
4. The report will appear shortly after in the left pane.

## Development and Testing 🧪

Expand Down

0 comments on commit 9894f53

Please sign in to comment.