nTraum/ETF2L

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# ETF2L
[![Build Status](https://travis-ci.org/nTraum/ETF2L.svg?branch=master)](https://travis-ci.org/nTraum/ETF2L)
[![Coverage Status](https://img.shields.io/coveralls/nTraum/ETF2L.svg)](https://coveralls.io/r/nTraum/ETF2L)
[![Dependency Status](https://gemnasium.com/nTraum/ETF2L.svg)](https://gemnasium.com/nTraum/ETF2L)
[![Code Climate](https://codeclimate.com/github/nTraum/ETF2L.png)](https://codeclimate.com/github/nTraum/ETF2L)

Ruby wrapper for the [ETF2L API](http://api.etf2l.org/).

## Installation

Add this line to your application's Gemfile:

```ruby
gem "etf2l"
```

And then execute:

```sh
$ bundle
```

Or install it yourself as:

```sh
$ gem install etf2l
```

## Usage

### Whitelists

Fetch an array of whitelists currently used in the ETF2L:

```ruby
whitelists = Etf2l::API.whitelists
whitelists.first.name #=> "ETF2L Ultiduo"
whitelists.first.url  #=> "http://etf2l.org/configs/etf2l_whitelist_ultiduo.txt"
```

## Contributing

1. Fork it ( https://github.com/nTraum/ETF2L/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