Update readme with installation instructions

Signed-off-by: Evan Owen <[email protected]>
kainosnoema · May 4, 2020 · a5bb906 · a5bb906
1 parent dd64540
commit a5bb906
Showing 1 changed file with 17 additions and 2 deletions.
diff --git 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]
+```