diff --git a/README.md b/README.md index 8e7547d..0a9fb93 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ file (`.markdownlint.{yaml,yml,json}`) or use our included default and scan all files with the `md` or `markdown` extension. ```yaml -- uses: articulate/actions-markdownlint@main +- uses: articulate/actions-markdownlint@v1 ``` You can set the config file, the files it scans, or files/directories to ignore. ```yaml -- uses: articulate/actions-markdownlint@main +- uses: articulate/actions-markdownlint@v1 with: config: markdownlint-config.json files: 'docs/**/*.md' diff --git a/action.yml b/action.yml index 488667b..2c03fc4 100644 --- a/action.yml +++ b/action.yml @@ -1,23 +1,23 @@ -name: 'markdownlint' -author: 'Articulate' -description: 'Lint your markdown' +name: markdown-lint +author: Articulate Global Inc. +description: Lint your markdown inputs: config: - description: 'markdownlint config file' + description: markdownlint config file required: false files: - description: 'Markdown files to scan' + description: Markdown files to scan required: false default: '**/*.{md,markdown}' ignore: - description: 'Files or directories to ignore' + description: Files or directories to ignore required: false fix: - description: 'Try to fix basic errors' + description: Try to fix basic errors required: false runs: - using: 'docker' - image: 'Dockerfile' + using: docker + image: Dockerfile branding: - color: 'blue' - icon: 'check-circle' + color: blue + icon: check-circle