From 09a6f114aec302bbc2165e1bdf07f9a8433bad11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Socho=C5=84?= Date: Fri, 9 Nov 2018 06:30:01 -0800 Subject: [PATCH] Update readme (#44) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update readme * fix urls so that they are absolute * add link to docker tags * minor formatting Signed-off-by: Michał Sochoń * ensure that titles follow standards in README.md Signed-off-by: Michał Sochoń * Spell check across README.md Signed-off-by: Michał Sochoń * Ensure docs describe order of loading of config files Signed-off-by: Michał Sochoń * Remove colon from title in README.md Signed-off-by: Michał Sochoń --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fb79479..8ac23f9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ It automatically detects charts changed against the target branch. ### Prerequisites -It is recommended to use the provided Docker image which can be [found on Quay](quay.io/helmpack/chart-testing/). +It is recommended to use the provided Docker image which can be [found on Quay](https://quay.io/helmpack/chart-testing/). It comes with all necessary tools installed. * Helm (http://helm.sh) @@ -27,7 +27,8 @@ Unpack the `ct` binary, add it to your PATH, and you are good to go! ### Docker Image -A Docker image is available at `quay.io/helmpack/chart-testing`. +A Docker image is available at `quay.io/helmpack/chart-testing` with list of +available tags [here](https://quay.io/repository/helmpack/chart-testing?tab=tags). ## Usage @@ -84,10 +85,16 @@ chart-dirs: build-id: pr-42 ``` -`ct install --config config.yaml` +#### Config Usage + + ct install --config config.yaml + `ct` supports any format [Viper](https://github.com/spf13/viper) can read, i. e. JSON, TOML, YAML, HCL, and Java properties files. +Notice that if no config file is specified, then `ct.yaml` (or any of the supported formats) is loaded from the current directory, `$HOME/.ct`, or `/etc/ct`, in that order, if found. + + ## Building from Source `ct` is built using Go 1.11. Older versions may work but have not been tested.