diff --git a/README.md b/README.md index 78fe0d8..c86ce37 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,16 @@ Docker image for updating PR status in Gitea ## Features -## Install +## Usage ```sh - +docker run --it \ + -e GITEA_HOST=YOUR_GITEA_HOST \ + -e ACCESS_TOKEN=YOUR_GITEA_ACCESS_TOKEN\ + docker.cluster.fun/averagemarcus/gitea-pr-status \ + "YOUR_USER/YOUR_REPO" \ + "GIT_COMMIT_SHA" \ + "PR_STATUS" ``` ## Building from source @@ -18,14 +24,10 @@ With Docker: make docker-build ``` -Standalone: - -```sh -make build -``` - ## Resources +* [API Documentation](https://try.gitea.io/api/swagger#/repository/repoCreateStatus) + ## Contributing If you find a bug or have an idea for a new feature please [raise an issue](/AverageMarcus/gitea-pr-status/issues/new) to discuss it.