From 6f2edb0be1460cf09e726011078ae14c717266a3 Mon Sep 17 00:00:00 2001 From: David Anson Date: Fri, 15 Jan 2021 20:25:42 -0800 Subject: [PATCH] Add another example to README.md. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d360419..2f592f9 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ for linting [Markdown][markdown]/[CommonMark][commonmark] files with Glob expression(s) of files to lint (newline-delimited) The default `*.{md,markdown}` lints all Markdown files in the base directory +of a project ## Outputs @@ -18,6 +19,12 @@ The default `*.{md,markdown}` lints all Markdown files in the base directory ## Examples +To lint Markdown files in the base directory of a project: + +```yaml +- uses: DavidAnson/markdownlint-cli2-action@v1 +``` + To lint all Markdown files in a project: ```yaml