From 3a7bae504edcd16656990adb047488fc1d6e1f19 Mon Sep 17 00:00:00 2001 From: NicolasVuillamy Date: Thu, 10 Sep 2020 09:48:11 +0200 Subject: [PATCH] Make Super-Linter more famous with badge links on repos using it :) --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index c714c16b..3b81163b 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ It is a simple combination of various linters, written in `bash`, to help valida - [Supported Linters](#supported-linters) - [How to use](#how-to-use) - [Example connecting GitHub Action Workflow](#example-connecting-github-action-workflow) + - [Add Super-Linter badge in your repository README](#add-super-linter-badge-in-your-repository-readme) - [Environment variables](#environment-variables) - [Template rules files](#template-rules-files) - [Disabling rules](#disabling-rules) @@ -160,6 +161,26 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +### Add Super-Linter badge in your repository README + +You can show Super-Linter status with a badge in your repository README + +[![GitHub Super-Linter](https://github.com/nvuillam/npm-groovy-lint/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) + +Format: + +```markdown +[![GitHub Super-Linter](https://github.com///workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) +``` + +Example: + +```markdown +[![GitHub Super-Linter](https://github.com/nvuillam/npm-groovy-lint/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) +``` + +_Note:_ IF you did not use `Lint Code Base` as GitHub Action name, please read [GitHub Actions Badges documentation](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#adding-a-workflow-status-badge-to-your-repository) + ## Environment variables The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality.