From 35efb355bc343672d8b3b3b186ca9a056147e5b4 Mon Sep 17 00:00:00 2001
From: ludeeus <joasoe@gmail.com>
Date: Fri, 29 May 2020 23:11:34 +0200
Subject: [PATCH] Update README

---
 README.md | 47 +++++++++++++++++++++++++++++++----------------
 1 file changed, 31 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index f5f47d4..37a1dfd 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,39 @@
-# SHELLCHECK
+# ShellCheck
 
-[![BuyMeCoffee][buymecoffeebedge]][buymecoffee]
-
-_Run shellcheck on ALL sh files in the repository._
+_GitHub action for ShellCheck._
 
 ## Example
 
-```
-workflow "Shellcheck" {
-  on = "push"
-  resolves = [
-    "Shellcheck",
-  ]
-}
+```yaml
+on: 
+  push:
+    branch:
+      - master
 
+name: 'Trigger: Push action'
 
-action "Shellcheck" {
-  uses = "ludeeus/actions/shellcheck@master"
-}
+jobs:
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Run ShellCheck
+      uses: ludeeus/action-shellcheck@master
 ```
 
-[buymecoffee]: https://www.buymeacoffee.com/ludeeus
-[buymecoffeebedge]: https://camo.githubusercontent.com/cd005dca0ef55d7725912ec03a936d3a7c8de5b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275792532306d6525323061253230636f666665652d646f6e6174652d79656c6c6f772e737667
+
+
+## Globally disable checks
+
+To disable specific checks add it to a `SHELLCHECK_OPTS` env key in the job definition.
+
+example:
+
+```yaml
+    ...
+    - name: Run ShellCheck
+      uses: ludeeus/action-shellcheck@master
+      env:
+        SHELLCHECK_OPTS: -e SC2059 -e SC2034 -e SC1090
+```