From 2b17b6e48009573bfee75b6f2b51bb1dacb05a2a Mon Sep 17 00:00:00 2001
From: Gareth Rushgrove <gareth@morethanseven.net>
Date: Wed, 30 Oct 2019 18:21:28 +0000
Subject: [PATCH] Added instructions for Helm Action

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index 1570232..7caad9f 100644
--- a/README.md
+++ b/README.md
@@ -27,3 +27,38 @@ passed to the action using `with`, as demonstrated with `files` in the above exa
 | policy | policy | Where to find the policy folder or files |
 | namespace | main | The Rego namespace to use for testing |
 | output | stdout | How to format the output from Conftest (stdout, json or tap) |
+
+
+## Helm
+
+Conftest also has a [Helm plugin](https://github.com/instrumenta/helm-conftest) which makes testing Helm charts easier, and
+that plugin is also available as an Action.
+
+You can use the action as follows:
+
+```yaml
+on: push
+name: Validate
+jobs:
+  conftest:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: test
+      uses: instrumenta/conftest-action/helm@master
+      with:
+        chart: mysql
+```
+
+The Conftest Helm Action has a small number of properties which map to the parameters for Conftest itself. These are
+passed to the action using `with`, as demonstrated with `chart` in the above example.
+
+| Property | Default | Description |
+| --- | --- | --- |
+| chart | - | *Required* which chart directory to test |
+| policy | policy | Where to find the policy folder or files |
+| namespace | main | The Rego namespace to use for testing |
+| output | stdout | How to format the output from Conftest (stdout, json or tap) |
+
+
+