Unified documentation and readme

This commit is contained in:
Thomas Boerger
2019-02-15 11:58:38 +01:00
parent 8165fde09a
commit 25a38556ca
+6 -6
View File
@@ -8,13 +8,13 @@
[![Go Doc](https://godoc.org/github.com/drone-plugins/drone-pypi?status.svg)](http://godoc.org/github.com/drone-plugins/drone-pypi) [![Go Doc](https://godoc.org/github.com/drone-plugins/drone-pypi?status.svg)](http://godoc.org/github.com/drone-plugins/drone-pypi)
[![Go Report](https://goreportcard.com/badge/github.com/drone-plugins/drone-pypi)](https://goreportcard.com/report/github.com/drone-plugins/drone-pypi) [![Go Report](https://goreportcard.com/badge/github.com/drone-plugins/drone-pypi)](https://goreportcard.com/report/github.com/drone-plugins/drone-pypi)
Drone Plugin for PyPi publishing with [twine](https://pypi.org/project/twine/). For the usage information and a listing of the available options please take a look at [the docs](http://plugins.drone.io/drone-plugins/drone-pypi/). Drone plugin to publish PyPi with [Twine](https://pypi.org/project/twine/). For the usage information and a listing of the available options please take a look at [the docs](http://plugins.drone.io/drone-plugins/drone-pypi/).
## Build ## Build
Build the binary with the following commands: Build the binary with the following command:
```Shell ```console
export GOOS=linux export GOOS=linux
export GOARCH=amd64 export GOARCH=amd64
export CGO_ENABLED=0 export CGO_ENABLED=0
@@ -25,9 +25,9 @@ go build -v -a -tags netgo -o release/linux/amd64/drone-pypi
## Docker ## Docker
Build the Docker image with the following commands: Build the Docker image with the following command:
```Shell ```console
docker build \ docker build \
--label org.label-schema.build-date=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \ --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) \ --label org.label-schema.vcs-ref=$(git rev-parse --short HEAD) \
@@ -36,7 +36,7 @@ docker build \
## Usage ## Usage
```Shell ```console
docker run --rm \ docker run --rm \
-e PLUGIN_USERNAME=jdoe \ -e PLUGIN_USERNAME=jdoe \
-e PLUGIN_PASSWORD=my_secret \ -e PLUGIN_PASSWORD=my_secret \