From 6888687646dbcd0b6ef3a0938ee00fa06b1da38e Mon Sep 17 00:00:00 2001
From: Ilir Bekteshi <Ilir.Bekteshi@qlik.com>
Date: Wed, 16 Oct 2019 11:10:34 +0200
Subject: [PATCH] Add docs

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1ca186c..371be34 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
-# action-yamllint
-GitHub Action - Yaml Lint
+# GitHub YAMLlint
+
+This action executes `yamllint` (https://github.com/adrienverge/yamllint) against file(s) or folder
+
+## Usage
+
+### Required parameters
+
+- `file_or_dir` - Enter file/folder (space speparated), wildcards accepted. Examples:
+    - `file1.yaml`
+    - `file1.yaml file2.yaml`
+    - `.` - run against all yaml files in current directory recursively
+    - `./**/*values.yaml` - run against all files that end with `values.yaml` recursively
+
+### Optional parameters
+
+- `config_file` - Path to custom configuration
+- `config_data` - Custom configuration (as YAML source)
+- `format` - Format for parsing output [parsable,standard]
+- `strict` - Return non-zero exit code on warnings as well as errors
+
+### Example usage in workflow
+
+```yaml
+name: Yaml Lint
+on: [push]
+jobs:
+  lintAllTheThings:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: yaml-lint
+      uses: ibiqlik/action-yamllint@master
+      with:
+        file_or_dir: ./**/*val*.yaml
+        config_file: .yamllint.yml
+```