Merge pull request #28 from glennsarti/add-docs

Update README with Language Server information

Author: jpogran

README.md

@@ -1,55 +1,96 @@
-# puppet-vscode
+<!--
+TODO: Need correct marketplace ID
+[![Version](https://vsmarketplacebadge.apphb.com/version/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
+[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
+-->
+
+# Puppet Language Support for Visual Studio Code
+
+This extension provides Puppet Language support for [Visual Studio Code](https://code.visualstudio.com/)
+
+## Platform support
+
+- Microsoft Windows
+- MacOSX
 
 ## Features
 
-## Syntax Highlighting
+- [Syntax highlighting](#Syntax_Highlighting)
+- [Code snippets](#Code_snippets)
+- IntelliSense for resources, parameters and more
+- Import from `puppet resource` directly into manifests
+- Node graph preview
+
+![Example of features](docs/assets/language_server.gif)
+
+## Requirements
+
+- Puppet Agent
+
+[Windows](https://docs.puppet.com/puppet/4.10/install_windows.html)
+
+[MacOSX](https://docs.puppet.com/puppet/4.10/install_osx.html)
+
+[Linux](https://docs.puppet.com/puppet/4.10/install_linux.html)
+
+## Feature information
+
+### Syntax Highlighting
+
+Syntax highlighting uses [puppet-lint](https://github.com/rodjek/puppet-lint) and displays the results as you type, within VSCode.
 
 - Puppet DSL
-- Puppet grammar
+- Puppet Grammar
 
-\!\[syntax\]\(images/syntax.png\)
+### Code Snippets
 
-## Snippet support
+As part of IntelliSense and Snippets, you can quickly create blocks of code
 
-\!\[feature X\]\(images/snippets.png\)
+### Puppet Resource
 
-## Puppet Linting support
+You can import existing resources directly using `puppet resource`
 
-On document save, puppet-lint will be run on the open file.
+1. Open the command palette (`Ctrl+Shift+P`)
 
-\!\[feature X\]\(images/puppet-lint.png\)
+2. Type `puppet resource` and press enter
 
-## Requirements
+3. Enter the resource type you want to import, for example `user`
+
+### Node Graph preview
+
+You can preview the [node graph](https://puppet.com/blog/visualize-your-infrastructure-models) of a manifest while you edit your Puppet Code.
+
+1. Open the command palette (`Ctrl+Shift+P`)
+
+2. Type `puppet open node`.. and press enter
+
+The node graph will appear next to the manifest
 
-- puppet-lint installed and available on the PATH or path to binary set in extension settings.
 
 ## Extension Settings
 
-This extension contributes the following settings:
+Coming!
 
-* `puppetLint.enable`: enable/disable this extension
-* `puppetLint.path`: set to the path to puppet-lint
+<!-- TODO -->
 
 ## Known Issues
 
 None yet.
 
 ## Release Notes
 
-**Note** Not released yet. WIP
-
-- syntax
-- grammar
-- linter
+**Note** Not released yet. Work in Progress
 
-### 0.0.1
+### 0.0.3
 
-Initial release of the puppet extension.
+Puppet Parser validate linter added
 
 ### 0.0.2
 
 Puppet Resource and Puppet Module commands.
 
-### 0.0.3
+### 0.0.1
+
+Initial release of the puppet extension.
+
 
-Puppet Parser validate linter added