Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
technosophos committed May 13, 2017
1 parent 17c4e15 commit 065187c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@

This Visual Studio Code extension provides [Kubernetes Helm](http://helm.sh) chart developers with a set of tools for creating and testing charts.

![screenshot of Helm extension](./screenshot.png)

## Features

- Syntax highlighting for YAML + Helm Templates
- Autocomplete for Helm, Sprig, and Go Tpl functions5
- Help text (on hover) for Helm, Sprig, and Go Tpl functions
- Snippets for quickly scaffolding new chart templates
- Commands for..
- **Helm: Lint**: Lint your chart
Expand All @@ -21,14 +25,18 @@ You must have [Helm](http://helm.sh) installed and configured. From there, you s
$ helm plugin install https://github.com/technosophos/helm-template
```

It is recommended that you also install `kubectl`, though this extension does not directly use it yet.

To use **Helm: DryRun** you must have your Kubernetes cluster running Tiller, and `$KUBECONFIG` pointing to that cluster.

## Extension Settings

* `vscode-helm.exclude`: Do not search the given paths when trying to find a chart.

## Known Issues

This extension has not been thoroughly tested on Windows.
- This extension has not been thoroughly tested on Windows.
- For deeply nested charts, template previews are generated against highest (umbrella) chart values (though for Helm Template calls you can pick your chart)

## Release Notes

Expand Down
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 065187c

Please sign in to comment.