Update README.md

Author: Carlos Rodríguez Hernández

README.md

@@ -6,8 +6,8 @@ This tools allows rendering Handlebars 3.0 templates, using as context data the
 
 # Basic usage
 
-```bash
-$> render-template --help
+```console
+$ render-template --help
 Usage:
   render-template [OPTIONS] [template-file]
 
@@ -25,26 +25,25 @@ The tool supports rendering templates from a file or from stdin (for convenience
 
 The source data is taken from the environment variables or from a data file, with properties-file format (key=value, a line for each pair). When a variable is defined both as an environment variable and in the data file, the latter will take precedence.
 
-
 # Examples
 
 ## Render data from template file with environment variables
 
-```bash
+```console
 # Create the template
-$> echo 'hello {{who}}' > template.tpl
+$ echo 'hello {{who}}' > template.tpl
 # Render it without 'who' variable
-$> render-template template.tpl
+$ render-template template.tpl
 hello 
 # Render it with 'who' variable defined
-$> who=bitnami render-template template.tpl
+$ who=bitnami render-template template.tpl
 hello bitnami
 ```
 
 ## Render data from stdin with environment variables
 
-```bash
-$> log_file=/tmp/stout.log port=8080 pid_file=/tmp/my.pid render-template <<"EOF"
+```console
+$ log_file=/tmp/stout.log port=8080 pid_file=/tmp/my.pid render-template <<"EOF"
 # My servide log file
 log_file "{{log_file}}"
 
@@ -67,20 +66,19 @@ port 8080
 
 # My service pid file
 pid_file "/tmp/my.pid"
-
 ```
 
 ## Render data from stdin with data file
 
-```bash
+```console
 # write data file
-$> cat > data.properties <<"EOF"
+$ cat > data.properties <<"EOF"
 log_file=/tmp/stout.log
 port=8080
 pid_file=/tmp/my.pid 
 EOF
 
-$> render-template --data-file ./data.properties <<"EOF"
+$ render-template --data-file ./data.properties <<"EOF"
 # My servide log file
 log_file "{{log_file}}"
 
@@ -107,39 +105,39 @@ pid_file "/tmp/my.pid"
 
 ## Overriding environment variables in data file
 
-```bash
+```console
 # Lets define some environment variables
-$> export name=foo
-$> export company=bar
-$> export year=3000
+$ export name=foo
+$ export company=bar
+$ export year=3000
 
 # And write a template
-$> cat > data.tpl <<"EOF"
+$ cat > data.tpl <<"EOF"
 {{name}} works at {{company}}
 since {{year}}
 EOF
 
 # Rendering from the environment would yield
-$> render-template data.tpl
+$ render-template data.tpl
 foo works at bar
 since 3000
 
 # But we can override it from a data file, either partially, to get a mix:
 
-$> echo "name=mike" > data.properties
-$> render-template --data-file data.properties data.tpl
+$ echo "name=mike" > data.properties
+$ render-template --data-file data.properties data.tpl
 mike works at bar
 since 3000
 
 # Or completely:
 
-$> cat > data.properties <<"EOF"
+$ cat > data.properties <<"EOF"
 name=mike
 company=Bitnami
 year=2010
 EOF
 
-$> render-template --data-file data.properties data.tpl
+$ render-template --data-file data.properties data.tpl
 mike works at Bitnami
 since 2010
 ```
@@ -148,8 +146,8 @@ since 2010
 
 The tool supports all the standard handlebars helpers: https://handlebarsjs.com/builtin_helpers.html
 
-~~~bash
-$> render-template <<"EOF" 
+```console
+$ render-template <<"EOF" 
  {{#if author}}
 {{firstName}} {{lastName}}
  {{else}}
@@ -160,7 +158,7 @@ EOF
 # Which outputs
 Unknown Author
 
-$> author=me firsName=foo lastName=bar render-template <<"EOF" 
+$ author=me firsName=foo lastName=bar render-template <<"EOF" 
  {{#if author}}
 {{firstName}} {{lastName}}
  {{else}}
@@ -170,91 +168,98 @@ EOF
 
 # Outputs:
 foo bar
-~~~
+```
 
 In addition, it includes a few custom helpers:
 
 ### json_escape
 
 The json_escape helper converts the  provided value into a valid JSON string
-~~~bash
-$> export VALUE='this is "a string", with quoting
+```console
+$ export VALUE='this is "a string", with quoting
 
 and some line breaks'
-~~~
+```
 Without the helper:
 
-~~~bash
-$> render-template <<<'VALUE={{VALUE}}'
+```console
+$ render-template <<<'VALUE={{VALUE}}'
 VALUE=this is "a string", with quoting
 
 and some line breaks
-~~~
+```
 
 Using the helper:
-~~~bash
-$> render-template <<<'VALUE={{json_escape VALUE}}'
+```console
+$ render-template <<<'VALUE={{json_escape VALUE}}'
 VALUE="this is \"a string\", with quoting\n\nand some line breaks"
-~~~
-
+```
 
 ### quote
 
 The quote helper Quotes a string
 
 Without the helper:
-~~~bash
-$> ARG1="some arg" ARG2="some other \"arg\"" render-template <<"EOF"
+```console
+$ ARG1="some arg" ARG2="some other \"arg\"" render-template <<"EOF"
 ARG1={{ARG1}} ARG2={{ARG2}}
 EOF
 ARG1=some arg ARG2=some other "arg"
-~~~
+```
 
 With the helper
 
-~~~bash
+```console
 ARG1="some arg" ARG2="some other \"arg\"" render-template <<"EOF"
 ARG1={{quote ARG1}} ARG2={{quote ARG2}}
 EOF
 ARG1="some arg" ARG2="some other \"arg\""
-~~~
+```
 
 ### or
 
 This helper allows using the "or" logical operation over two values (a value will be true if not empty)
 
 To render a block when either "firstName" or "lastName" values ar not empty:
 
-~~~bash
-$> cat > data.tpl <<"EOF" 
+```console
+$ cat > data.tpl <<"EOF" 
 {{#if (or firstName lastName)}}
 {{firstName}} {{lastName}}
 {{else}}
 Unknown Author
 {{/if}}
 EOF
 
-$>render-template data.tpl
+$ render-template data.tpl
 Unknown Author
 
-$> firstName=foo render-template data.tpl
+$ firstName=foo render-template data.tpl
 foo
 
-$> lastName=bar render-template data.tpl
- bar
+$ lastName=bar render-template data.tpl
+bar
  
-$> firstName=foo lastName=bar render-template data.tpl
+$ firstName=foo lastName=bar render-template data.tpl
 foo bar
-~~~
+```
 
 This helper can also be used to provide defaults for your template variables:
 
-~~~bash
+```console
 # No value provided, so we fallback to the second "or" argument
-$> render-template <<<'VALUE={{or ENV_VALUE "default value"}}'
+$ render-template <<<'VALUE={{or ENV_VALUE "default value"}}'
 VALUE=default value
 
 # ENV_VALUE is defined, so we take it
-$> ENV_VALUE="customized value" render-template <<<'VALUE={{or ENV_VALUE "default value"}}'
+$ ENV_VALUE="customized value" render-template <<<'VALUE={{or ENV_VALUE "default value"}}'
 VALUE=customized value
-~~~
+```
+
+## License
+
+Copyright &copy; 2023 Bitnami
+
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.