diff --git a/README.md b/README.md index 19be4f3..327797f 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ Helm-ls is a [helm](https://github.com/helm/helm) language server protocol [LSP] - [coc.nvim setup](#cocnvim-setup) - [VSCode](#vscode) - [Emacs eglot setup](#emacs-eglot-setup) +- [Features](#features) - [Contributing](#contributing) - [License](#license) @@ -304,6 +305,25 @@ Alternatively, you can include a comment such as the following at the top of Hel # -*- mode: helm -*- +## Features + +
+ + Hover + + + + +| Language Construct | Example Effect | +| ------------------ | ---------------------------------------------------------------------------------- | +| Values | `.Values.replicaCount` shows the value of `replicaCount` in the values.yaml files. | +| Built-In-Objects | `.Chart.Name` shows the name of the Chart. | +| Includes | `include "example.labels"` shows the defintion of the template. | +| Functions | `add` shows the docs of the add function. | +| Yaml in Templates | `Kind` shows the docs from the yaml-schema (via yaml-language-server). | + +
+ ## Contributing Thank you for considering contributing to Helm-ls project! diff --git a/readme-assets/hover.mp4 b/readme-assets/hover.mp4 new file mode 100644 index 0000000..78a4a79 Binary files /dev/null and b/readme-assets/hover.mp4 differ