golangci-lint/README.md
Isaev Denis f920f77a38
docs: fill README.md (#1098)
Add info about github action.
Make a search placeholder waiting for
access to algolia docsearch.
2020-05-16 18:44:37 +03:00

44 lines
1.7 KiB
Markdown

<a href=""><img src="" width="250px"></a>
<p align="center">
<img alt="golangci-lint logo" src="assets/go.png" height="150" />
<h3 align="center">golangci-lint</h3>
<p align="center">Fast linters runner for Go</p>
</p>
---
`golangci-lint` is a fast Go linters runner. It runs linters in parallel, uses caching, supports `yaml` config, has integrations
with all major IDE and has dozens of linters included.
## Install `golangci-lint`
- [On my machine](https://golangci-lint.run/usage/install/#ci-installation);
- [On CI/CD systems](https://golangci-lint.run/usage/install/#local-installation).
## Documentation
Documentation is hosted at https://golangci-lint.run.
## Badges
![Build Status](https://github.com/golangci/golangci-lint/workflows/CI/badge.svg)
[![License](https://img.shields.io/github/license/golangci/golangci-lint)](/LICENSE)
[![Release](https://img.shields.io/github/release/golangci/golangci-lint.svg)](https://github.com/golangci/golangci-lint/releases/latest)
[![Docker](https://img.shields.io/docker/pulls/golangci/golangci-lint)](https://hub.docker.com/r/golangci/golangci-lint)
[![Github Releases Stats of golangci-lint](https://img.shields.io/github/downloads/golangci/golangci-lint/total.svg?logo=github)](https://somsubhra.com/github-release-stats/?username=golangci&repository=golangci-lint)
## Contributors
This project exists thanks to all the people who contribute.
<a href="https://github.com/golangci/golangci-lint/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=golangci/golangci-lint" />
</a>
<!-- TODO: use `allcontributors` -->
## Stargazers over time
[![Stargazers over time](https://starchart.cc/golangci/golangci-lint.svg)](https://starchart.cc/golangci/golangci-lint)