Skip to content

Commit 002bf80

Browse files
committed
docs(README.md): add shellcheck link and usage example
1 parent 41f2738 commit 002bf80

1 file changed

Lines changed: 32 additions & 9 deletions

File tree

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,46 @@ The go-dev docker container provides a lightweight Go development environment fo
77

88
## Image Contents
99

10-
* based on the [official go Docker image](https://hub.docker.com/_/golang/)
11-
* [glide](https://github.com/Masterminds/glide): go dependency management
12-
* [golint](https://github.com/golang/lint): go source code linter
13-
* [ginkgo](https://github.com/onsi/ginkgo): BDD testing framework for go
14-
* [upx](http://upx.sourceforge.net/): executable packer
15-
* [gox](https://github.com/mitchellh/gox): simple go cross-compiling tool
10+
* based on the [official go Docker image][]
11+
* [ginkgo][]: BDD testing framework for go
12+
* [glide][]: go dependency management
13+
* [golint][]: go source code linter
14+
* [gox][]: simple go cross-compiling tool
15+
* [shellcheck][]: static analysis for shell scripts
16+
* [upx][]: executable packer
1617

1718
## Usage
1819

19-
The latest Docker image is available via:
20+
Mount your local go code into a container's `$GOPATH` to run any `go` command or one of the
21+
included tools or scripts. Here's an example of running `glide up` for deis/builder:
2022

21-
* [Quay.io](https://quay.io)
23+
```console
24+
$ docker run --rm \
25+
--env GO15VENDOREXPERIMENT=1 \
26+
--volume $GOPATH/src/github.com/deis/builder:/go/src/github.com/deis/builder \
27+
--workdir /go/src/github.com/deis/builder \
28+
quay.io/deis/go-dev:latest \
29+
glide up
30+
```
31+
32+
The latest deis/go-dev Docker image is available at:
33+
34+
* [Quay.io][]
2235
```
2336
docker pull quay.io/deis/go-dev
2437
```
2538

26-
* [Docker Hub](https://hub.docker.com)
39+
* [Docker Hub][]
2740
```
2841
docker pull deis/go-dev
2942
```
43+
44+
[Docker Hub]: https://hub.docker.com
45+
[ginkgo]: https://github.com/onsi/ginkgo
46+
[glide]: https://github.com/Masterminds/glide
47+
[golint]: https://github.com/golang/lint
48+
[gox]: https://github.com/mitchellh/gox
49+
[official go Docker image]: https://hub.docker.com/_/golang/
50+
[Quay.io]: https://quay.io
51+
[shellcheck]: https://github.com/koalaman/shellcheck
52+
[upx]: http://upx.sourceforge.net/

0 commit comments

Comments
 (0)