# mdcat

[![Gem Version](https://badge.fury.io/rb/mdcat.svg)](https://badge.fury.io/rb/mdcat)
[![Build Status](https://travis-ci.org/dvinciguerra/mdcat.svg?branch=master)](https://travis-ci.org/dvinciguerra/mdcat)
[![Maintainability](https://api.codeclimate.com/v1/badges/cf154e97f0e6c10614b4/maintainability)](https://codeclimate.com/github/dvinciguerra/mdcat/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/cf154e97f0e6c10614b4/test_coverage)](https://codeclimate.com/github/dvinciguerra/mdcat/test_coverage)

`mdcat` is a command line tool write in Ruby to display markdown files in the terminal.

## Installation

The recommended way to install `mdcat` is via RubyGems:

    $ gem install mdcat

## Usage

### Displaying a file

    $ mdcat README.md

### For help

    $ mdcat help


## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dvinciguerra/mdcat.


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).


## Author

[Daniel Vinciguerra](https://github.com/dvinciguerra)