Add examples for command=fix/config to README.md, tweak test name.

DavidAnson · Jul 23, 2022 · 70a2f84 · 70a2f84
1 parent b20e49c
commit 70a2f84
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -58,7 +58,7 @@ jobs:
           config/test.markdownlint.jsonc
           test/*
   command-config-invalid:
-    name: Command = config (invalid, fails)
+    name: Command = config (invalid configuration file, fails)
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3

diff --git a/README.md b/README.md
@@ -67,6 +67,26 @@ To lint specific Markdown files in a project:
       docs/*.md
 ```
 
+To fix supported issues when linting:
+
+```yaml
+- uses: DavidAnson/markdownlint-cli2-action@v5
+  with:
+    command: fix
+    globs: '**/*.md'
+```
+
+To specify a custom configuration file:
+
+```yaml
+- uses: DavidAnson/markdownlint-cli2-action@v5
+  with:
+    command: config
+    globs: |
+      config/custom.markdownlint.jsonc
+      **/*.md
+```
+
 To prevent linting issues from failing the workflow run:
 
 ```yaml