actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-29 04:01:02 -05:00
Code Issues Projects Releases Packages Wiki Activity

Add gif to readme

Browse source
This commit is contained in:
Zack Koppert 2020-06-30 16:45:08 -07:00 committed by GitHub
parent d9a9b6246e
commit 35a0a7a26d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -59,9 +59,11 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
| **YAML** | [YamlLint](https://github.com/adrienverge/yamllint) | | **YAML** | [YamlLint](https://github.com/adrienverge/yamllint) |
## How to use ## How to use
<img height="250" align="right" src="https://github.com/github/super-linter/blob/quickstart/docs/how-to.gif?raw=true" alt="How to gif">
To use this **GitHub** Action you will need to complete the following: To use this **GitHub** Action you will need to complete the following:
1. Create a new file in your repository called `.github/workflows/linter.yml` 1. Create a new file in your repository called `.github/workflows/linter.yml`
2. Copy the example workflow from below into that new file 2. Copy the example workflow from below into that new file, no extra configuration required
3. Commit that file to a new branch 3. Commit that file to a new branch
4. Open up a pull request and observe the action working 4. Open up a pull request and observe the action working
5. Enjoy your more *stable*, and *cleaner* code base 5. Enjoy your more *stable*, and *cleaner* code base