diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..f9cc168 --- /dev/null +++ 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 \ No newline at end of file diff --git a/examples/code.png b/examples/code.png new file mode 100644 index 0000000..b6c0df1 Binary files /dev/null and b/examples/code.png differ diff --git a/examples/markdown.png b/examples/markdown.png new file mode 100644 index 0000000..30575a8 Binary files /dev/null and b/examples/markdown.png differ diff --git a/examples/table.png b/examples/table.png new file mode 100644 index 0000000..e0d8517 Binary files /dev/null and b/examples/table.png differ