fix: README

fix: Makefile
2021-09-08 19:44:53 +02:00 · 2021-09-08 19:38:08 +02:00
2 changed files with 13 additions and 1 deletions
--- a/1
+++ b/1
@ -2,7 +2,6 @@
 # Only required to install a specifiy version
 MARKDOWNLINT_VERSION?=

-
 # CONTAINER_RUNTIME
 # The CONTAINER_RUNTIME variable will be used to specified the path to a
 # container runtime. This is needed to start and run a container image.
--- a/README.md
+++ 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).
Author	SHA1	Message	Date
Markus Pesch	40d7da11c1	fix: README All checks were successful continuous-integration/drone/push Build is passing Details	2021-09-08 19:44:53 +02:00
Markus Pesch	d748da0378	fix: Makefile All checks were successful continuous-integration/drone/push Build is passing Details	2021-09-08 19:38:08 +02:00