From 9a0dbb882a7273c3533204766f30ac273a4942e1 Mon Sep 17 00:00:00 2001 From: Eric Norris Date: Wed, 19 May 2021 12:59:12 -0400 Subject: [PATCH] docs: update README --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 963a682..626e39e 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,15 @@ A seamless launcher for Terraform. ## Installation +### Homebrew + +**Note:** installing `terraform-demux` via Homebrew will automatically create a symlink named `terraform`. + +1. `brew tap etsy/terraform-demux https://github.com/etsy/terraform-demux` +2. `brew install terraform-demux` + +### Manual + 1. Grab the latest binary from the [releases page](https://github.com/etsy/terraform-demux/releases) 2. Copy it to a location in your `$PATH` as `terraform` (or leave it as `terraform-demux` if you'd like) @@ -14,6 +23,10 @@ A seamless launcher for Terraform. Simply navigate to any folder that contains Terraform configuration and run `terraform` as you usually would. `terraform-demux` will attempt to locate the appropriate [version constraint](https://www.terraform.io/docs/language/expressions/version-constraints.html) by searching in the current working directory and recursively through parent directories. If `terraform-demux` cannot determine a constraint, it will default to the latest possible version. -## Where does `terraform-demux` keep its data? +### Logging + +Setting the `DEMUX_LOG` environment variable to any non-empty value will cause `terraform-demux` to write out debug logs to `stderr`. + +## Cache Directory -`terraform-demux` keeps a cache of Hashicorp's releases index and downloaded Terraform binaries in the directory returned by [os.UserCacheDir](https://golang.org/pkg/os/#UserCacheDir), under `terraform-demux/`. +`terraform-demux` keeps a cache of Hashicorp's releases index and downloaded Terraform binaries in the directory returned by [os.UserCacheDir](https://golang.org/pkg/os/#UserCacheDir), under `terraform-demux/` (e.g. `~/Library/Caches/terraform-demux/` on MacOS).