Skip to content

Commit

Permalink
chore: add getting started steps
Browse files Browse the repository at this point in the history
  • Loading branch information
hugorut committed Jun 28, 2022
1 parent 0bd38ae commit 30f63a4
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 2 deletions.
Binary file added .github/assets/infracost-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/maintf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/terraform-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/videooverlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,19 @@ If a simple monthly cost isn't enough for you, just click the overview to show a

Check out the video below to see the Infracost extension in action!

https://user-images.githubusercontent.com/6455139/169564807-320bbbf7-647f-4248-882f-2a6bbf9449b2.mp4
[![Extension Demo](https://github.com/infracost/vscode-infracost/blob/master/.github/assets/videooverlay.png?raw=true))](https://user-images.githubusercontent.com/6455139/169564807-320bbbf7-647f-4248-882f-2a6bbf9449b2.mp4)


## Getting started

1. Install [Infracost CLI](https://www.infracost.io/docs/#1-install-infracost) on your machine & register for an API key.
2. Open VSCode and install the [Hashicorp Terraform extension](https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform).
![](https://github.com/infracost/vscode-infracost/blob/master/.github/assets/terraform-install.png?raw=true)
3. Then install the [Infracost extension](https://marketplace.visualstudio.com/items?itemName=Infracost.infracost).
![](https://github.com/infracost/vscode-infracost/blob/master/.github/assets/infracost-install.png?raw=true)
4. Navigate to any Terraform file, if you've done the prior steps correctly you'll see costs above [supported blocks](https://www.infracost.io/docs/supported_resources/overview/).
![](https://github.com/infracost/vscode-infracost/blob/master/.github/assets/maintf.png?raw=true)

## Requirements

The Infracost VSCode extension requires you to have:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "infracost",
"displayName": "Infracost",
"description": "Cloud cost estimates for Terraform in your editor",
"version": "0.1.3",
"version": "0.1.4",
"publisher": "Infracost",
"license": "Apache-2.0",
"icon": "infracost-logo.png",
Expand Down

0 comments on commit 30f63a4

Please sign in to comment.