diff --git a/README.md b/README.md index e69de29..9b6d35f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,41 @@ +# Claude PR Review + +## Description + +Reviews a PR using Claude + +## Inputs + +| name | description | required | default | +| -------------------- | ------------------------------------------------------------- | -------- | ------- | +| `ANTHROPIC_API_KEY` |

The API key for the anthropic API

| `true` | `""` | +| `GITEA_URL` |

The URL of the Gitea instance

| `true` | `""` | +| `GITEA_CLAUDE_TOKEN` |

The token of the claude account for the Gitea instance

| `true` | `""` | + +## Runs + +This action is a `composite` action. + +## Usage + +```yaml +- uses: ***PROJECT***@***VERSION*** + with: + ANTHROPIC_API_KEY: + # The API key for the anthropic API + # + # Required: true + # Default: "" + + GITEA_URL: + # The URL of the Gitea instance + # + # Required: true + # Default: "" + + GITEA_CLAUDE_TOKEN: + # The token of the claude account for the Gitea instance + # + # Required: true + # Default: "" +```