Skip to content

Commit 08137c6

Browse files
committed
Unified documentation and readme
1 parent 0127eb1 commit 08137c6

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,31 @@ Drone plugin for sending build notifications to [Matrix](https://matrix.org/). F
1212

1313
## Build
1414

15-
Build the binary with the following commands:
15+
Build the binary with the following command:
1616

17-
```
18-
go build
17+
```console
18+
export GOOS=linux
19+
export GOARCH=amd64
20+
export CGO_ENABLED=0
21+
export GO111MODULE=on
22+
23+
go build -v -a -tags netgo -o release/linux/amd64/drone-matrix
1924
```
2025

2126
## Docker
2227

23-
Build the Docker image with the following commands:
28+
Build the Docker image with the following command:
2429

25-
```
26-
GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -tags netgo -o release/linux/amd64/drone-matrix
27-
docker build --rm -t plugins/matrix .
30+
```console
31+
docker build \
32+
--label org.label-schema.build-date=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
33+
--label org.label-schema.vcs-ref=$(git rev-parse --short HEAD) \
34+
--file docker/Dockerfile.linux.amd64 --tag plugins/matrix .
2835
```
2936

30-
### Usage
37+
## Usage
3138

32-
```
39+
```console
3340
docker run --rm \
3441
-e PLUGIN_ROOMID=0123456789abcdef:matrix.org \
3542
-e PLUGIN_USERNAME=yourbot \

0 commit comments

Comments
 (0)