From d97ec23dc14fd2fc841007f6829701f0ba0e64d8 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Thu, 14 Apr 2022 10:58:25 +0100 Subject: [PATCH] Tweak docs to match new TUI output (#27) Signed-off-by: Jacob Tomlinson --- CONTRIBUTING.md | 2 +- README.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d4f112..2558945 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ This project is written in Go and uses `make` for task running. Code should be f You can build Canary into `./bin/canary` with: ```shell -$ make +$ make build go build -o bin/canary . ``` diff --git a/README.md b/README.md index 8b57dd2..3b97df5 100644 --- a/README.md +++ b/README.md @@ -131,12 +131,12 @@ We can then run our specification against any desired container image to see a p ```console $ canary validate --file examples/kubeflow.yaml public.ecr.aws/j1r0q0g6/notebooks/notebook-servers/jupyter-scipy:v1.5.0-rc.1 Validating public.ecr.aws/j1r0q0g6/notebooks/notebook-servers/jupyter-scipy:v1.5.0-rc.1 against kubeflow - 👩 User is jovyan [true] - 🆔 User ID is 1000 [true] - 🏠 Home directory is /home/jovyan [true] - 🌏 Exposes an HTTP interface on port 8888 [true] - 🧭 Correctly routes the NB_PREFIX [true] - 🔓 Sets 'Access-Control-Allow-Origin: *' header [true] + 👩 User is jovyan [passed] + 🆔 User ID is 1000 [passed] + 🏠 Home directory is /home/jovyan [passed] + 🌏 Exposes an HTTP interface on port 8888 [passed] + 🧭 Correctly routes the NB_PREFIX [passed] + 🔓 Sets 'Access-Control-Allow-Origin: *' header [passed] validation passed ```