Refine the readme (#152)

README.md

@@ -1,76 +1,81 @@
 # Azure Terraform
+[![Build Status](https://travis-ci.org/Azure/vscode-azureterraform.svg?branch=master)](https://travis-ci.org/Azure/vscode-azureterraform)
+[![Release Status](https://vsmarketplacebadge.apphb.com/version-short/ms-azuretools.vscode-azureterraform.svg)](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureterraform)
 
 The VSCode Azure Terraform extension is designed to increase developer productivity authoring, testing and using Terraform with Azure. The extension provides terraform command support, resource graph visualization and CloudShell integration inside VSCode.
 
-![overview](images/overview.png)
-
-## Features
-
-The features in this extension support execution in integrated terminal mode or remotely using Azure CloudShell and Azure Container Instance. Some features only run locally at this time and will require some local dependencies.
-
-This extension supports the following features:
-
-- Terraform commands: init, plan, apply, validate, refresh and destroy.
-- Visualize the terraform module.
-
-### Azure Terraform: init
-
-Executes `terraform init` command against the current project workspace.  If run with terminal set to CloudShell, will run `terraform init` in CloudShell.
-
-### Azure Terraform: plan
-
-Executes `terraform plan` command against the current project workspace.  If run with terminal set to CloudShell, will run `terraform plan` in CloudShell.
-
-### Azure Terraform: apply
-
-Executes `terraform apply` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform apply` in CloudShell.
-
-### Azure Terraform: validate
-
-Executes `terraform validate` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform validate` in CloudShell.
-
-### Azure Terraform: refresh
-
-Executes `terraform refresh` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform refresh` in CloudShell.
-
-### Azure Terraform: destroy
-
-Executes `terraform destroy` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform destroy` in CloudShell.
-
-### Azure Terraform: visualize
-
-> NOTE: only runs locally.
-
-Creates a visual representation of the components of the module and save it in `graph.png`. This command requires [GraphViz dot](http://www.graphviz.org) to be installed locally.
-
-### Azure Terraform: push
-
-This command will sync workspace files that meet the filter `azureTerraform.files` setting in your configuration to Azure clouddrive.
+![overview](https://raw.githubusercontent.com/Azure/vscode-azureterraform/master/images/overview.png)
 
 ## Requirements
 
 This extension requires:
 
 - [Terraform](https://www.terraform.io/downloads.html)
-- [Node.js 6.0+](https://nodejs.org) if you are using the CloudShell.
+- [Node.js 6.0+](https://nodejs.org) if you are using the Cloud Shell.
 - [GraphViz dot](http://www.graphviz.org) if you are using the visualize feature.
 
-> NOTE: On Windows after installing the graphViz msi/zip, you will most likely need to add your PATH env variable `(Ex. c:\Program Files(x86)\GraphViz2.38\bin)` in order to use dot from the command line.
+> NOTE: Please make sure these requirements are in your PATH environment variable.
 
-## Supported Environments
+## Features
 
-- [Microsoft Azure](https://azure.microsoft.com)
+The features in this extension support execution in integrated terminal mode or remotely using Azure Cloud Shell. Some features only run locally at this time and will require some local dependencies.
+
+This extension supports the following features:
+
+- Terraform commands: init, plan, apply, validate, refresh and destroy.
+- Visualize the terraform module.
+
+## Commands
+
+Open the Command Palette (`Command`+`Shift`+`P` on macOS and `Ctrl`+`Shift`+`P` on Windows/Linux) and type in one of the following commands:
+
+<table>
+  <thead>
+  <tr>
+    <th>Command</th>
+    <th>Description</th>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+    <td width="35%">
+      Basic commands:<br>
+      <ul>
+        <li>Azure Terraform: init</li>
+        <li>Azure Terraform: plan</li>
+        <li>Azure Terraform: apply</li>
+        <li>Azure Terraform: validate</li>
+        <li>Azure Terraform: refresh</li>
+        <li>Azure Terraform: destroy</li>
+      </ul>
+    </td>
+    <td>
+      Execute terraform command against the current project workspace.
+      If run with terminal set to Cloud Shell, will run the command in Cloud Shell.
+    </td>
+  </tr>
+  <tr>
+    <td>Azure Terraform: visualize</td>
+    <td>Create a visual representation of the components of the module and save it in <code>graph.png</code>.</td>
+  </tr>
+  <tr>
+    <td>Azure Terraform: push</td>
+    <td>Push workspace files that meet the filter <code>azureTerraform.files</code> setting in your configuration to Cloud Shell.</td>
+  </tr>
+  </tbody>
+</table>
 
 ## Extension Settings
 
 - `azureTerraform.terminal` - Specifies terminal used to run Terraform commands. Valid settings are `cloudshell` or `integrated`
 - `azureTerraform.files` - Indicates the files that should be synchronized to Azure CloudShell using the glob pattern string, for example `**/*.{tf,txt,yml,tfvars,rb}`
 
-## Known Issues
-
-- Windows support for dot has some unhandled exception cases.  We are working to improve this area.
-- We do not support private registry. The test container has to be on docker hub at this time.
-
 ## Release Notes
 
 Refer to [CHANGELOG](CHANGELOG.md)
+
+## Telemetry
+VS Code collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkID=528096&clcid=0x409) to learn more. If you don’t wish to send usage data to Microsoft, you can set the `telemetry.enableTelemetry` setting to `false`. Learn more in our [FAQ](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting).
+
+## License
+[MIT](LICENSE.md)