kmoschcau/yard-sequel

[![Gem Version](https://badge.fury.io/rb/yard-sequel.svg)](https://badge.fury.io/rb/yard-sequel)
[![Build Status](https://travis-ci.org/kmoschcau/yard-sequel.svg?branch=master)](https://travis-ci.org/kmoschcau/yard-sequel)
[![Code Climate](https://codeclimate.com/github/kmoschcau/yard-sequel/badges/gpa.svg)](https://codeclimate.com/github/kmoschcau/yard-sequel)
[![Coverage Status](https://coveralls.io/repos/github/kmoschcau/yard-sequel/badge.svg?branch=master)](https://coveralls.io/github/kmoschcau/yard-sequel?branch=master)
[![Inline docs](http://inch-ci.org/github/kmoschcau/yard-sequel.svg?branch=master&style=shields)](http://inch-ci.org/github/kmoschcau/yard-sequel)
[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/kmoschcau/yard-sequel/master)

# yard-sequel

A plugin for the Yard documentation tool to automatically document
Sequel code.

## Installation

Install it as:

    $ gem install yard-sequel

## Usage

Install the gem on the system you generate documentation on and enable
plugins or just this plugin in your `~/.yard/config`.

## Development

To install this gem onto your local machine, run
`bundle exec rake install`.

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/kmoschcau/yard-sequel.
This project is intended to be a safe, welcoming space for
collaboration, and contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of
conduct.

## License

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