From 4451301ea1b83228362d6f0d5eacc5e69db18c00 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Mon, 17 Apr 2017 20:43:43 +0200 Subject: [PATCH] Improve documentation Signed-off-by: Knut Ahlers --- README.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1f374eb..363bfc5 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,32 @@ ## Available functions -- Take key-value pairs from the CLI and replace them inside the template: -`echo "{{ .foo }}" | korvike -v foo=bar => "bar"` -- Read environment variables and replace them inside the template: -`export FOO=bar; echo '{{env "FOO"}}' | korvike => "bar"` -- Read a file and place it inside the template: -`echo "Hello World" > hello; echo '{{file "hello"}}' | korvike => "Hello World"` -- Format the current date into the template (uses [Go time format](https://golang.org/pkg/time/#Time.Format)): -`echo '{{now "2006-01-02 15:04:05"}}' | korvike => "2017-04-17 16:27:34"` +- `{{ . }}` + Take key-value pairs from the CLI and replace them inside the template + ```bash + # echo "{{ .foo }}" | korvike -v foo=bar + bar + ``` +- `{{ env [default value] }}` + Read environment variables and replace them inside the template + ```bash + # export FOO=bar + # echo '{{env "FOO"}}' | korvike + bar + ``` +- `{{ file [default value] }}` + Read a file and place it inside the template + ```bash + # echo "Hello World" > hello + # echo '{{file "hello"}}' | korvike + Hello World + ``` +- `{{ now }}` + Format the current date into the template (uses [Go time format](https://golang.org/pkg/time/#Time.Format)) + ```bash + # echo '{{now "2006-01-02 15:04:05"}}' | korvike + 2017-04-17 16:27:34 + ``` ----