diff --git a/README.md b/README.md
index 4279bf69..b7c7eddd 100644
--- a/README.md
+++ b/README.md
@@ -16,30 +16,36 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review PRs
**Auto-Description**: Automatically generating PR description - name, type, summary, and code walkthrough.
\
-**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused, and various suggestions for the PR content.
+**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused PR, and various suggestions for the PR content.
\
**Question Answering**: Answering free-text questions about the PR.
\
**Code Suggestion**: Committable code suggestions for improving the PR.
-Example results:
+
Example results:
-Describe:
+Describe:
-Ask:
+Review:
+
+
+
+
+
+Ask:
-Code Suggestion:
+Improve:
-
+
@@ -124,11 +130,11 @@ Possible questions you can ask include:
- Is the PR ready for merge?
- What are the main changes in this PR?
- Should this PR be split into smaller parts?
-- Can you compose a rhymed song about this PR.
+- Can you compose a rhymed song about this PR?
---
-#### Method 2: Run as a Github Action
+#### Method 2: Run as a GitHub Action
You can use our pre-built Github Action Docker image to run PR-Agent as a Github Action.
@@ -157,12 +163,12 @@ jobs:
OPENAI_KEY:
```
-The GITHUB_TOKEN secret is automatically created by Github.
+The GITHUB_TOKEN secret is automatically created by GitHub.
3. Merge this change to your main branch.
When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools.
-4. You may configure PR-Agent by adding environment variables under the env section that corresponds to any configurable property in the [configuration](./CONFIGURATION.md) file. Some examples:
+4. You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](./CONFIGURATION.md) file. Some examples:
```yaml
env:
# ... previous environment values
@@ -216,7 +222,7 @@ python pr_agent/servers/github_polling.py
---
-#### Method 5: Run as a Github App, allowing you to automate the review process on your private or public repositories.
+#### Method 5: Run as a GitHub App, allowing you to automate the review process on your private or public repositories.
1. Create a GitHub App from the [Github Developer Portal](https://docs.github.com/en/developers/apps/creating-a-github-app).
@@ -236,7 +242,7 @@ WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
3. Acquire the following pieces of information from your app's settings page:
- - App private key (click "Generate a private key", and save the file)
+ - App private key (click "Generate a private key" and save the file)
- App ID
4. Clone this repository:
@@ -267,12 +273,12 @@ docker push codiumai/pr-agent:github_app # Push to your Docker repository
7. Host the app using a server, serverless function, or container environment. Alternatively, for development and
debugging, you may use tools like smee.io to forward webhooks to your local machine.
-8. Go back to your app's settings, set the following:
+8. Go back to your app's settings, and set the following:
- - Webhook URL: The URL of your app's server, or the URL of the smee.io channel.
+ - Webhook URL: The URL of your app's server or the URL of the smee.io channel.
- Webhook secret: The secret you generated earlier.
-9. Install the app by navigating to the "Install App" tab, and selecting your desired repositories.
+9. Install the app by navigating to the "Install App" tab and selecting your desired repositories.
---
@@ -280,10 +286,10 @@ docker push codiumai/pr-agent:github_app # Push to your Docker repository
**PR-Agent** provides four types of interactions ("tools"): `"PR Reviewer"`, `"PR Q&A"`, `"PR Description"` and `"PR Code Sueggestions"`.
-- The "PR Reviewer" tool automatically analyzes PRs, and provides different types of feedbacks.
+- The "PR Reviewer" tool automatically analyzes PRs, and provides different types of feedback.
- The "PR Ask" tool answers free-text questions about the PR.
- The "PR Description" tool automatically sets the PR Title and body.
-- The "PR Code Suggestion" tool provide inline code suggestions for the PR, that can be applied and committed.
+- The "PR Code Suggestion" tool provide inline code suggestions for the PR that can be applied and committed.
## How it works
diff --git a/pics/improve.gif b/pics/improve.gif
new file mode 100644
index 00000000..97c94f67
Binary files /dev/null and b/pics/improve.gif differ
diff --git a/pics/review.gif b/pics/review.gif
new file mode 100644
index 00000000..2f9e7457
Binary files /dev/null and b/pics/review.gif differ