Skip to content

Commit aa8f668

Browse files
authored
Merge pull request #3 from tinkerbell/tstromberg-patch-1
Fully populate the README with badges and such
2 parents 2e711de + 0dd5cba commit aa8f668

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
# lint-install
22

3-
Install sanely configured linters to your project.
3+
[![GoReport Widget]][GoReport Status]
4+
![](https://img.shields.io/badge/Stability-Experimental-red.svg)
45

5-
This tool specifically supports creating and updating `Makefile` targets, with configured linters for the following languages:
6+
[GoReport Status]: https://goreportcard.com/report/github.com/tinkerbell/lint-install
7+
[GoReport Widget]: https://goreportcard.com/badge/github.com/tinkerbell/lint-install
8+
9+
Install well-configured linters to your project in a consistent and repeatable way. This tool specifically supports creating and updating `Makefile`
10+
targets, and lints the following:
611

712
- Go
813
- Shell
914
- Dockerfile
1015

1116
## Philosophy
1217

13-
Catch as much as possible, but don't warn about issues that the language authors themselves do not believe in.
18+
Catch as many errors as possible, but be idiomatic to the language.
1419

1520
## Usage
1621

1722
```
1823
go get github.com/tinkerbell/lint-install
19-
lint-install <repo>
24+
$HOME/go/bin/lint-install <repo>
2025
```
2126

2227
## Options
@@ -25,9 +30,3 @@ lint-install <repo>
2530
* `--shell=warn`: Make shell warnings non-fatal
2631
* `--dockerfile=warn`: Make Dockerfile warnings non-fatal
2732
* `--go=warn`: Make Dockerfile warnings non-fatal
28-
29-
## Languages
30-
31-
- Go
32-
- Shell
33-
- Dockerfile

0 commit comments

Comments
 (0)