From aba407fff349a76dead6af5c60b45c26c57edcae Mon Sep 17 00:00:00 2001 From: powerOFMAX Date: Thu, 25 Jun 2020 21:08:05 -0300 Subject: [PATCH] Add Table of Contents to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 6f4799f2..7b89a709 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,20 @@ The end goal of this tool: - Build guidelines for code layout and format - Automate the process to help streamline code reviews + +## Table of Contents + +* [How it works](#how-it-works) +* [Supported linters](#supported-linters) +* [Usage](#how-to-use) +* [Environment variables](#environment-variables) +* [Disable rules](#disabling-rules) +* [Docker Hub](#docker-hub) +* [Run Super-Linter locally](#running-super-linter-locally-troubleshootingdebuggingenhancements) + * [CI / CT/ CD](#cictcd) +* [Limitations](#limitations) + + ## How it Works The super-linter finds issues and reports them to the console output. Fixes are suggested in the console output but not automatically fixed, and a status check will show up as failed on the pull request.