Contents

# Clever::Ruby

[![Build Status](https://ci.ops.clever.com/api/badge/github.com/Clever/clever-ruby/status.svg?style=flat&branch=master)](https://ci.ops.clever.com/github.com/Clever/clever-ruby)

Ruby bindings to the Clever API. [Documentation](http://rubydoc.info/gems/clever-ruby/frames)

## Installation

Add this line to your application's Gemfile:

```bash
gem 'clever-ruby'
```

And then execute:

```bash
$ bundle
```

Or install it yourself as:

```bash
$ gem install clever-ruby
```

## Usage

Configure clever-ruby to use your Clever token:

```ruby
Clever.configure do |config|
  config.token = 'YOUR-API-TOKEN'
end
```

See the [documentation](http://rubydoc.info/gems/clever-ruby/frames) for
further details.

## Run tests

To run all tests:

```bash
$ rake test
```

To run all tests and the linter ([rubocop](https://github.com/bbatsov/rubocop)):

```bash
$ rake
```

The linter follows the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions. To just run the linter:

```bash
$ rake lint
```

Running specific tests is not currently supported.

## Documentation

To generate it to `./doc`:

```bash
$ rake doc
```

To see documentation coverage:

```bash
$ rake doc-coverage
```

and then view `doc_coverage.txt`.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git add -p ./path/to/files; git commit -m 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
clever-ruby-0.11.1	README.md
clever-ruby-0.11.0	README.md