aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9c8ae04..d816262 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,35 @@
# showReadiness
-A simple golang application to explore [liveness and readiness checks](http://kubernetes.io/docs/user-guide/pod-states/) in Kubernetes.
+A simple golang application to explore [liveness and readiness checks][1] in
+Kubernetes.
## To build
+
In the cloned directory, run the following:
-```
+
+Linux/OSX:
+
+```bash
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -tags netgo -installsuffix netgo -ldflags '-w -s' .
```
-## To build with only Docker
-Ensure [docker](https://www.docker.com/get-docker) is installed. In the cloned directory, run the folowing:
+Windows:
+```powershell
+$env:CGO_ENABLED=0; $env:GOOS="linux"; $env:GOARCH="amd64"; go build -a -tags netgo -installsuffix netgo -ldflags "-s"
```
-docker run --rm -v $PWD:/go/src/github.com/tydavis/showreadiness -w /go/src/github.com/tydavis/showreadiness golang:alpine /bin/sh -c "CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -tags netgo -installsuffix netgo -ldflags '-w -s' . "
+
+Or type your
+
+## To build with only Docker
+
+If [docker][2] is installed, run the folowing in the checked-out directory:
+
+```bash
+docker run --rm -v $PWD:/go/src/github.com/tydavis/showreadiness \
+-w /go/src/github.com/tydavis/showreadiness golang:alpine /bin/sh \
+-c "CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -tags netgo -installsuffix netgo -ldflags '-w -s' . "
```
+[1]:http://kubernetes.io/docs/user-guide/pod-states/
+[2]:https://www.docker.com/get-docker \ No newline at end of file