docs: added example to README.md

README.md

@@ -191,6 +191,37 @@ Or mark 429 status code as alive:
 }
 ```
 
+## Example Usage
+
+Consider a workflow file that checks for the status of hyperlinks on push to the master branch, 
+
+``` yml
+name: Check .md links
+
+on:
+  push: [master]
+  
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    # check out the latest version of the code
+    steps:
+    - uses: actions/checkout@v3
+
+    # Checks the status of hyperlinks in .md files in verbose mode
+    - name: Check links
+      uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-verbose-mode: 'yes'
+```
+A file `test.md` exists, containing
+
+
+
+On running the workflow described above, the output shown below is obtained
+
+
+
 ## Versioning
 GitHub Action - Markdown link check follows the [GitHub recommended versioning strategy](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md).