Skip to content

Commit 6f1a1a1

Browse files
committed
update README with new build instructions and badges
Signed-off-by: CrazyMax <[email protected]>
1 parent 667e470 commit 6f1a1a1

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
[![GitHub release](https://img.shields.io/github/release/docker/docker-credential-helpers.svg?style=flat-square)](https://github.com/docker/docker-credential-helpers/releases/latest)
2+
[![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/docker-credential-helpers)
3+
[![Build Status](https://img.shields.io/github/workflow/status/docker/docker-credential-helpers/build?label=build&logo=github&style=flat-square)](https://github.com/docker/docker-credential-helpers/actions?query=workflow%3Abuild)
4+
[![Codecov](https://img.shields.io/codecov/c/github/docker/docker-credential-helpers?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/docker-credential-helpers)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/docker/docker-credential-helpers?style=flat-square)](https://goreportcard.com/report/github.com/docker/docker-credential-helpers)
6+
17
## Introduction
28

39
docker-credential-helpers is a suite of programs to use native stores to keep Docker credentials safe.
@@ -6,9 +12,21 @@ docker-credential-helpers is a suite of programs to use native stores to keep Do
612

713
Go to the [Releases](https://github.com/docker/docker-credential-helpers/releases) page and download the binary that works better for you. Put that binary in your `$PATH`, so Docker can find it.
814

9-
### Building from scratch
15+
## Building
16+
17+
You can build the credential helpers using Docker:
18+
19+
```shell
20+
# create builder
21+
$ docker buildx create --use
22+
# build credential helpers from remote repository and output to ./bin/build
23+
$ docker buildx bake "https://github.com/docker/docker-credential-helpers.git"
24+
# or from local source
25+
$ git clone https://github.com/docker/docker-credential-helpers.git
26+
$ docker buildx bake
27+
```
1028

11-
The programs in this repository are written with the Go programming language. These instructions assume that you have previous knowledge about the language and you have it installed in your machine.
29+
Or if the toolchain is already installed on your machine:
1230

1331
1 - Download the source and put it in your `$GOPATH` with `go get`.
1432

0 commit comments

Comments
 (0)