From 347e4ce6b6c9b0052e8fce726f65bdcaa2665359 Mon Sep 17 00:00:00 2001
From: Ain Tohvri <ain@flashbit.net>
Date: Sat, 9 Dec 2023 15:08:01 +0100
Subject: [PATCH] Add README

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3cd311b..2f66a9b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
 # falco-github-action
-Falco GitHub Action for VCL validation at CI level
+
+Falco GitHub Action for VCL validation.
+
+## Usage
+
+```yaml
+      - name: Lint VCL
+        uses: ain/falco-github-action@latest
+        with:
+          subcommand: lint
+          options: "-v -I test/vcl/includes"
+          target: test/vcl/valid_with_include.vcl
+```
+
+## Inputs
+
+| Input | Default | Description |
+| ----- | ------- | ----------- |
+| `subdommand` | `lint` | Run linting on VCL (or ACL) |
+| `options` | - | Optional flags, see [Common Flags of Falco](https://github.com/ysugimoto/falco#usage) |
+| `target` | - | VCL (or ACL) to targeted, e.g. lint |
+
+## Licence
+
+Copyright © 2023 Ain Tohvri. Licenced under [MIT](LICENSE).