Spring/spring-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Few more tweaks to README

Browse Source
This commit is contained in:
Kris De Volder
2016-12-19 11:33:36 -08:00
parent ddf8b7bc32
commit 08d97021f2
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
vscode-extensions/vscode-manifest-yaml/README.md
View File

@@ -3,28 +3,31 @@
This extension provides basic validation, content assist and hover infos
for editing Cloud Foundry [Manifest](https://docs.cloudfoundry.org/devguide/deploy-apps/manifest.html) Files.
## Validation
## Usage
The CF manifest editor automatically activates when the name of the `.yml` file you are editing,
matches the glob pattern: `manifest*.yml`.
## Functionality
### Validation
As you type the manifest is parsed and checked for basic syntactic and structural correctness. Hover over
an error marker to see an explanation.
![Linting Screenshot](https://github.com/spring-projects/sts4/raw/master/vscode-extensions/vscode-manifest-yaml/readme-imgs/linting.png)
## Content assist
### Content assist
Having trouble remembering all the names of the attributes, and their spelling? Content assist to the
rescue:
![Content Assist Screenshot](https://github.com/spring-projects/sts4/raw/master/vscode-extensions/vscode-manifest-yaml/readme-imgs/content-assist.png)
## Documentation Hovers
### Documentation Hovers
Having trouble remembering exactly what the meaning of each attribute is? Hover over any attribute and
read its detailed documentation.
![Hover Docs Screenshot](https://github.com/spring-projects/sts4/raw/master/vscode-extensions/vscode-manifest-yaml/readme-imgs/hovers.png)
## Activation
The CF manifest editor automatically activates when the name of the `.yml` file you are editing,
matches the glob pattern: `manifest*.yml`.