centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 04:48:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

Update download instruction to use tar.gz

Browse Source 
We recently started using GoReleaser for release workflow and to be able
to support all the use-cases (brew, scopp, etc) the preferred way of
assets distribution is gonna be a packaged format (tar.z and zip).

For the time being the standalone binary will also be included in GitHub
release assets, but will be deprecated in the upcoming releases.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
Khosrow Moossavi
2021-02-08 16:34:59 -05:00
parent 5bdcdb1782
commit 24e7cbab7d
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -66,12 +66,13 @@ Stable binaries are also available on the [releases] page. To install, download
binary for your platform from "Assets" and place this into your `$PATH`:
```bash
curl -Lo ./terraform-docs https://github.com/terraform-docs/terraform-docs/releases/download/v0.10.1/terraform-docs-v0.10.1-$(uname)-amd64
chmod +x ./terraform-docs
mv ./terraform-docs /some-dir-in-your-PATH/terraform-docs
curl -Lo ./terraform-docs.tar.gz https://github.com/terraform-docs/terraform-docs/releases/download/v0.10.1/terraform-docs-v0.10.1-$(uname)-amd64.tar.gz
tar -xzf terraform-docs.tar.gz
chmod +x terraform-docs
mv terraform-docs /some-dir-in-your-PATH/terraform-docs
```
**NOTE:** Windows releases are in `EXE` format.
**NOTE:** Windows releases are in `ZIP` format.
If you are a Mac OS X user, you can use [Homebrew]: