diff --git a/README.md b/README.md index 08af6c8..8f1eeeb 100644 --- a/README.md +++ b/README.md @@ -190,6 +190,26 @@ There are excellent AI code review tools on the market. PR-AF is not designed to ## Quick Start +### Deploy with Railway (fastest) + +[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/pr-af) + +One click deploys PR-AF + the AgentField control plane + PostgreSQL. Set two environment variables in Railway: + +- `OPENROUTER_API_KEY` — your [OpenRouter](https://openrouter.ai/keys) key (routes to the review models) +- `GH_TOKEN` — GitHub personal access token with `repo` scope, for reading PRs and posting reviews + +Once deployed, trigger a review against the control plane (the public endpoint requires the `X-API-Key` header set to your `AGENTFIELD_API_KEY`): + +```bash +curl -X POST https://.up.railway.app/api/v1/execute/async/pr-af.review \ + -H "Content-Type: application/json" \ + -H "X-API-Key: " \ + -d '{"input": {"pr_url": "https://github.com/owner/repo/pull/123"}}' +``` + +### Run locally (Docker Compose) + ```bash git clone https://github.com/Agent-Field/pr-af.git && cd pr-af cp .env.example .env # Add OPENROUTER_API_KEY, GH_TOKEN