akinomurasame/redpen_ruby

# RedPenRuby

[![Gem Version](https://badge.fury.io/rb/redpen_ruby.svg)](http://badge.fury.io/rb/redpen_ruby)
[![Build Status](https://travis-ci.org/akinomurasame/redpen_ruby.svg?branch=travis-ci)](https://travis-ci.org/akinomurasame/redpen_ruby)
[![Coverage Status](https://coveralls.io/repos/akinomurasame/redpen_ruby/badge.png?branch=coveralls)](https://coveralls.io/r/akinomurasame/redpen_ruby?branch=coveralls)
[![Code Climate](https://codeclimate.com/github/akinomurasame/redpen_ruby/badges/gpa.svg)](https://codeclimate.com/github/akinomurasame/redpen_ruby)

RedPenRuby is a Ruby wrapper for [redpen: a text inspection tool](https://github.com/recruit-tech/redpen).

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'redpen_ruby'
```

And then execute:

    $ bundle install --path vendor/bundle --binstubs vendor/bundle/bin

Or install it yourself as:

    $ gem install redpen_ruby

## Usage

Usage CLI:

    $ bundle exec redpen_ruby /path/to/config.xml /path/to/target_file

Usage Ruby script:

```ruby
require 'redpen_ruby'

config_file = './lib/redpen-cli-1.1/conf/redpen-conf-en.xml'
target_file = './lib/redpen-cli-1.1/sample-doc/en/sampledoc-en.md'

redpen = RedpenRuby.check(config_file, target_file)

if redpen.valid?
  puts 'Ok, Valid!'
else
  puts redpen.messages
end
```

## Contributing

1. Fork it ( https://github.com/[my-github-username]/redpen_ruby/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request