Skip to content

Commit

Permalink
Merge pull request #7 from hairyhenderson/readme-details
Browse files Browse the repository at this point in the history
📖 Adding details to README
  • Loading branch information
hairyhenderson committed Jan 24, 2016
2 parents 42a88a4 + 993d65b commit fa02542
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

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

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.

## Usage

At the moment, `gomplate` just replaces environment variables. All environment variables are available by referencing `.Env` in the template.

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

Use it like this:

```console
$ echo "Hello, {{.Env.USER}}" | gomplate
Hello, hairyhenderson
Expand Down

0 comments on commit fa02542

Please sign in to comment.