add readme

MichaelMure · Nov 24, 2019 · 81e2854 · 81e2854
1 parent aae0b4d
commit 81e2854
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,32 @@
+# mdr : MarkDown Renderer
+
+[![Build Status](https://travis-ci.org/MichaelMure/mdr.svg?branch=master)](https://travis-ci.org/MichaelMure/mdr)
+[![Go Report Card](https://goreportcard.com/badge/github.com/MichaelMure/mdr)](https://goreportcard.com/report/github.com/MichaelMure/mdr)
+[![GitHub license](https://img.shields.io/github/license/MichaelMure/mdr.svg)](https://github.com/MichaelMure/mdr/blob/master/LICENSE)
+[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/the-git-bug/Lobby)
+
+`mdr` is a standalone Markdown renderer for the terminal.
+
+Note: Markdown being originally designed to render as HTML, rendering in a terminal is occasionally challenging and some adaptation had to be made. 
+
+## Examples
+
+![rendered markdown](examples/markdown.png)
+![rendered table](examples/table.png)
+![rendered code](examples/code.png)
+
+## Installation
+
+You can grab a [pre-compiled binary](https://github.com/MichaelMure/mdr/releases/latest)
+
+## Origin
+
+This tool is an offspring of the [git-bug](https://github.com/MichaelMure/git-bug) project.
+
+## Contribute
+
+PRs accepted.
+
+## License
+
+MIT
diff --git a/examples/code.png b/examples/code.png
diff --git a/examples/markdown.png b/examples/markdown.png
diff --git a/examples/table.png b/examples/table.png