Skip to content

Commit 4c3e341

Browse files
committed
(GH-99) Improve Readme instructions
This addresses most of the concerns in GH-99 by updating the readme instructions. It reorders the sections to put the requirements and quick start first along with miscellaneous edits
1 parent ed48a69 commit 4c3e341

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

client/README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ This extension provides full Puppet Language support for [Visual Studio Code](ht
99

1010
**It is currently in technical preview, so that we can gather bug reports and find out what new features to add.**
1111

12+
## Requirements
13+
14+
You will need to have Puppet Agent installed in order to fully use this extension. You can find instructions and installation links here:
15+
16+
* [Windows](https://docs.puppet.com/puppet/latest/install_windows.html)
17+
* [MacOSX](https://docs.puppet.com/puppet/latest/install_osx.html)
18+
* [Linux](https://docs.puppet.com/puppet/latest/install_linux.html)
19+
20+
## Quick start
21+
22+
Open any Puppet manifest with the extension '.pp' or 'epp' and the extension will load automatically. Once loaded the extension will be available for the duration of the session.
23+
24+
![Example of features](docs/assets/language_server.gif)
25+
1226
## Platform support
1327

1428
- Microsoft Windows
@@ -17,23 +31,13 @@ This extension provides full Puppet Language support for [Visual Studio Code](ht
1731

1832
## Features
1933

20-
- [Syntax highlighting](#Syntax_Highlighting)
21-
- [Code snippets](#Code_snippets)
34+
- Syntax highlighting
35+
- Code snippets
36+
- Linting
2237
- IntelliSense for resources, parameters and more
2338
- Import from `puppet resource` directly into manifests
2439
- Node graph preview
2540

26-
27-
![Example of features](docs/assets/language_server.gif)
28-
29-
## Requirements
30-
31-
You will need to have Puppet Agent installed in order to fully use this extension. You can find instructions and installation links here:
32-
33-
* [Windows](https://docs.puppet.com/puppet/4.10/install_windows.html)
34-
* [MacOSX](https://docs.puppet.com/puppet/4.10/install_osx.html)
35-
* [Linux](https://docs.puppet.com/puppet/4.10/install_linux.html)
36-
3741
## Feature information
3842

3943
### Syntax Highlighting
@@ -107,4 +111,4 @@ Restart Visual Studio Code and try to reproduce the problem, then examine the lo
107111

108112
## License
109113

110-
This extension is [licensed under the Apache-2.0 License](LICENSE.txt).
114+
This extension is [licensed under the Apache-2.0 License](LICENSE.txt).

client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,4 +180,4 @@
180180
"dependencies": {
181181
"vscode-languageclient": "^3.1.0"
182182
}
183-
}
183+
}

0 commit comments

Comments
 (0)