Unified documentation and readme

This commit is contained in:
Thomas Boerger 2019-02-15 11:58:34 +01:00
parent 0127eb1730
commit 08137c6e18
No known key found for this signature in database
GPG Key ID: 09745AFF9D63C79B

View File

@ -12,24 +12,31 @@ Drone plugin for sending build notifications to [Matrix](https://matrix.org/). F
## Build
Build the binary with the following commands:
Build the binary with the following command:
```
go build
```console
export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on
go build -v -a -tags netgo -o release/linux/amd64/drone-matrix
```
## Docker
Build the Docker image with the following commands:
Build the Docker image with the following command:
```
GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -tags netgo -o release/linux/amd64/drone-matrix
docker build --rm -t plugins/matrix .
```console
docker build \
--label org.label-schema.build-date=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
--label org.label-schema.vcs-ref=$(git rev-parse --short HEAD) \
--file docker/Dockerfile.linux.amd64 --tag plugins/matrix .
```
### Usage
## Usage
```
```console
docker run --rm \
-e PLUGIN_ROOMID=0123456789abcdef:matrix.org \
-e PLUGIN_USERNAME=yourbot \