docs: update readme add annotations

hoijui · Nov 28, 2022 · 004129e · 004129e
1 parent bafb38b
commit 004129e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ Check for broken links in markup files. Currently `html` and `markdown` files ar
 * Efficient link resolving strategy which tries with minimized network load
 * Throttle option to prevent *429 Too Many Requests* errors
 * Configure via config file
+* Report broken links via GitHub workflow commands
 
 ## Install Locally
 
@@ -58,6 +59,10 @@ Use *mlc* command line arguments using the `with` argument:
     args: ./README.md
 ```
 
+The action does uses [GitHub workflow commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions) to highlight broken links:
+
+![annotation](./docs/FailingAnnotation.PNG)
+
 ### Binary
 
 To integrate *mlc* in your CI pipeline running in a *linux x86_64 environment* you can add the following commands to download the tool:

diff --git a/docs/FailingAnnotation.PNG b/docs/FailingAnnotation.PNG