From f0fa50af9035b9b74faed024b7ab68935ca51c0c Mon Sep 17 00:00:00 2001 From: Markus Pesch Date: Tue, 12 Nov 2019 20:16:46 +0100 Subject: [PATCH] fix(README): usage --- README.md | 53 ++++++++++++++--------------------------------------- 1 file changed, 14 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index b44e18c..ba60060 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,21 @@ [![GoDoc Reference](https://godoc.org/github.com/volker-raschek/docker-hub-description-updater?status.svg)](http://godoc.org/github.com/volker-raschek/docker-hub-description-updater) [![Docker Pulls](https://img.shields.io/docker/pulls/volkerraschek/dhdu)](https://hub.docker.com/r/volkerraschek/dhdu) -By specifying the login data for hub.docker.com you can update the short and -long description of a docker repository. +By specifying the login data for [hub.docker.com](https://hub.docker.com) you +can update the short and long description of a docker repository. ## Usage -Several options are available to update the descriptions. Either based on -Markdown files or as a normal string, which is passed as argument when calling. -The examples below describe two ways, the binary and container based way. - -### Example 1: Update full description of the repository with a Markdown file +The examples below describe two ways to update the full description of the +docker hub repository. First by the binary and second by a container based way. ```bash dhdu \ - -user= \ - -password= \ - -namespace= \ - -repository= \ - -full-description-file=./README.md + --user= \ + --password= \ + --namespace= \ + --repository= \ + --file=./README.md ``` ```bash @@ -30,33 +27,11 @@ docker run \ --rm \ --volume $(pwd):/workspace \ volkerraschek/dhdu \ - -user= \ - -password= \ - -namespace= \ - -repository= \ - -full-description-file=./README.md -``` - -### Example 2: Update full description of the repository over an argument - -```bash -dhdu -user= \ - -password= \ - -namespace= \ - -repository= \ - -full-description="My awesome description" -``` - -```bash -docker run \ - --rm \ - --volume $(pwd):/workspace \ - volkerraschek/dhdu \ - -user= \ - -password= \ - -namespace= \ - -repository= \ - -full-description="My awesome description" + --user= \ + --password= \ + --namespace= \ + --repository= \ + --file=./README.md ``` ## Compiling the source code