Skip to content

Commit 78abd1e

Browse files
Merge pull request #30 from hairyhenderson/readme-update
A few README tweaks
2 parents fdbba8a + 636645e commit 78abd1e

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
# gomplate
44

5-
A simple [Go template](https://golang.org/pkg/text/template/)-based alternative to [`envsubst`](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html).
5+
A [Go template](https://golang.org/pkg/text/template/)-based alternative to [`envsubst`](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html).
66

77
I really like `envsubst` for use as a super-minimalist template processor. But its simplicity is also its biggest flaw: it's all-or-nothing with shell-like variables.
88

9-
Gomplate is an alternative that will let you process templates which also include shell-like variables.
9+
Gomplate is an alternative that will let you process templates which also include shell-like variables. Also there are some useful built-in functions that can be used to make templates even more expressive.
1010

1111
## Usage
1212

13-
At the moment, `gomplate` just replaces environment variables. All environment variables are available by referencing `.Env` in the template.
13+
The usual and most basic usage of `gomplate` is to just replace environment variables. All environment variables are available by referencing `.Env` (or `getenv`) in the template.
1414

1515
The template is read from standard in, and written to standard out.
1616

@@ -75,7 +75,7 @@ foo
7575

7676
#### `json`
7777

78-
Converts a JSON string into an object. Only works for JSON Objects. This can be used to access properties of JSON objects.
78+
Converts a JSON string into an object. Only works for JSON Objects (not Arrays or other valid JSON types). This can be used to access properties of JSON objects.
7979

8080
##### Example
8181

0 commit comments

Comments
 (0)