Skip to content
This repository has been archived by the owner on Feb 22, 2019. It is now read-only.

simplereach/outbrain-api

Repository files navigation

Code Climate

THIS IS CURRENTLY A WIP.

PLEASE WAIT TILL 1.0 RELEASE TO USE IN PRODUCTION.

Outbrain::Api

A simple wrapper for the outbrain api.

Installation

Add this line to your application's Gemfile:

gem 'outbrain-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install outbrain-api

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/simplereach/outbrain-api.

License

The gem is available as open source under the terms of the MIT License.