From a5bb906cb8e2d2e4679958c32878d4e284a1b3ff Mon Sep 17 00:00:00 2001 From: Evan Owen Date: Mon, 4 May 2020 15:31:39 -0700 Subject: [PATCH] Update readme with installation instructions Signed-off-by: Evan Owen --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 166c294..af345cd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ -# terracost-cli +# terracost [![Actions Status](https://github.com/kainosnoema/terracost-cli/workflows/Test/badge.svg)](https://github.com/kainosnoema/terracost-cli/actions) -AWS cost estimation for Terraform projects (depends on terracost.io API) +AWS cost estimation for Terraform projects using a custom API hosted at terracost.io. Does not read or upload any Terraform state, variables, or outputs. + +## Installation + +### Homebrew + +```console +$ brew install kainosnoema/tap/terracost +``` + +### Usage + +In Terraform project directory: +``` +$ terracost estimate [plan file] +```