From 40d7da11c1db4c0b33b1bccfd6a3d4551ac282a8 Mon Sep 17 00:00:00 2001 From: Markus Pesch Date: Wed, 8 Sep 2021 19:44:53 +0200 Subject: [PATCH] fix: README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8df8c70 --- /dev/null +++ b/README.md @@ -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).