Updated readme
This commit is contained in:
parent
34f4834977
commit
90bf230fc5
18
README.md
18
README.md
@ -4,10 +4,16 @@ Docker image for updating PR status in Gitea
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
## Install
|
## Usage
|
||||||
|
|
||||||
```sh
|
```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
|
## Building from source
|
||||||
@ -18,14 +24,10 @@ With Docker:
|
|||||||
make docker-build
|
make docker-build
|
||||||
```
|
```
|
||||||
|
|
||||||
Standalone:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
make build
|
|
||||||
```
|
|
||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
|
* [API Documentation](https://try.gitea.io/api/swagger#/repository/repoCreateStatus)
|
||||||
|
|
||||||
## Contributing
|
## 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.
|
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.
|
||||||
|
Loading…
Reference in New Issue
Block a user