Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michaelherold/rom-todotxt

Todo.txt support for ROM
https://github.com/michaelherold/rom-todotxt

Last synced: 7 days ago
JSON representation

Todo.txt support for ROM

Awesome Lists containing this project

README

        

# ROM::TodoTxt

[![Build Status](https://travis-ci.org/michaelherold/rom-todotxt.svg?branch=master)][travis]
[![Dependency Status](https://gemnasium.com/michaelherold/rom-todotxt.png)][gemnasium]
[![Code Climate](https://codeclimate.com/github/michaelherold/rom-todotxt/badges/gpa.svg)][codeclimate]
[![Test Coverage](https://codeclimate.com/github/michaelherold/rom-todotxt/badges/coverage.svg)][codeclimate]
[![Inline docs](http://inch-ci.org/github/michaelherold/rom-todotxt.svg?branch=master)][inchpages]

todo.txt support for [Ruby Object Mapper](https://github.com/michaelherold/rom)

[travis]: https://travis-ci.org/michaelherold/rom-todotxt
[gemnasium]: https://gemnasium.com/michaelherold/rom-todotxt
[codeclimate]: https://codeclimate.com/github/michaelherold/rom-todotxt
[inchpages]: http://inch-ci.org/github/michaelherold/rom-todotxt

## Installation

Add this line to your application's Gemfile:

```ruby
gem "rom-todotxt"
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install rom-todotxt

## Usage

See `spec/integration/repository_spec.rb` or the [examples] folder for sample
usage.

[examples]: https://github.com/michaelherold/rom-todotxt/tree/master/examples

## Copyright

Copyright © 2015 Michael Herold. Open sourced under the terms of the
[MIT License](http://opensource.org/licenses/MIT).