fix: README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Markus Pesch 2021-09-08 19:44:53 +02:00
parent d748da0378
commit 40d7da11c1
Signed by: volker.raschek
GPG Key ID: 852BCC170D81A982

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# markdownlint-docker
[![Build Status](https://drone.cryptic.systems/api/badges/volker.raschek/markdownlint-docker/status.svg)](https://drone.cryptic.systems/volker.raschek/markdownlint-docker)
[![Docker Pulls](https://img.shields.io/docker/pulls/volkerraschek/markdownlint)](https://hub.docker.com/r/volkerraschek/markdownlint)
This project contains all sources to build the container image
`docker.io/volkerraschek/markdownlint`. The primary goal of this project is to
packge the binary `markdownlint-ci` as container image. The source code of the
binary can be found in the upstream project of
[igorshubovych](https://github.com/igorshubovych/markdownlint-cli).
The workflow or how `markdownlint-ci` can in general be used is documented
[here](https://github.com/igorshubovych/markdownlint-cli#usage).