Skip to content

Commit

Permalink
Merge pull request #30 from hairyhenderson/readme-update
Browse files Browse the repository at this point in the history
A few README tweaks
  • Loading branch information
hairyhenderson committed Mar 28, 2016
2 parents fdbba8a + 636645e commit 78abd1e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

# gomplate

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).
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).

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.

Gomplate is an alternative that will let you process templates which also include shell-like variables.
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.

## Usage

At the moment, `gomplate` just replaces environment variables. All environment variables are available by referencing `.Env` in the template.
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.

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

Expand Down Expand Up @@ -75,7 +75,7 @@ foo

#### `json`

Converts a JSON string into an object. Only works for JSON Objects. This can be used to access properties of JSON objects.
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.

##### Example

Expand Down

0 comments on commit 78abd1e

Please sign in to comment.