diff --git a/vscode-extensions/vscode-manifest-yaml/README.md b/vscode-extensions/vscode-manifest-yaml/README.md index 39e768170..bbbb73562 100644 --- a/vscode-extensions/vscode-manifest-yaml/README.md +++ b/vscode-extensions/vscode-manifest-yaml/README.md @@ -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`. \ No newline at end of file