From d499dc9103771515e01b964dd8d056340ca5a774 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Mon, 4 May 2020 21:06:29 -0700 Subject: [PATCH] docs: clarify action behavior in README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 49059a6f..46e4db30 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,12 @@ The end goal of this tool: - Build guidelines for code layout and format - Automate the process to help streamline code reviews +## 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. + +## Supported Linters + Developers on **GitHub** can call the **GitHub Action** to lint their code base with the following list of linters: | *Language* | *Linter* |