Skip to content

Commit 41e230a

Browse files
committed
clarify two hosting options and add diagrams
1 parent a2e7863 commit 41e230a

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GitHub Code Review Agent
22

3-
A GitHub App for automated code reviews using Hono.js and Amp.
3+
Automated code reviews using Amp AI with two deployment options: **GitHub Actions** or **Webhook Service**.
44

55
## Features
66

@@ -13,9 +13,16 @@ A GitHub App for automated code reviews using Hono.js and Amp.
1313

1414
**Requirements**: Amp account with API key required for code reviews.
1515

16+
## Deployment Options
17+
18+
| Option | Setup | Maintenance |
19+
|--------|-------|-------------|
20+
| **GitHub Actions** | Copy workflow file | None |
21+
| **Webhook Service** | GitHub App + hosting | Server management |
22+
1623
## Quick Start
1724

18-
### GitHub Actions (Recommended)
25+
### Option 1: GitHub Actions (Recommended)
1926

2027
The simplest way to add code reviews to any repository:
2128

@@ -32,6 +39,14 @@ The simplest way to add code reviews to any repository:
3239

3340
3. **Create a pull request** - reviews will run automatically!
3441

42+
<img src="gh_actions_gh_cra.png" alt="GitHub Actions Setup" width="400">
43+
44+
### Option 2: Webhook Service (Advanced)
45+
46+
For production use with full API access, queue management, and custom integrations.
47+
48+
<img src="self_hosted_gh_cra.png" alt="Self-hosted Service" width="400">
49+
3550
### Docker Image (For Actions)
3651

3752
To build and publish the Docker image:

gh_actions_gh_cra.png

206 KB
Loading

self_hosted_gh_cra.png

211 KB
Loading

0 commit comments

Comments
 (0)