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

https://github.com/pcboy/wordref

Tiny wrapper for the Wordreference API
https://github.com/pcboy/wordref

Last synced: about 1 year ago
JSON representation

Tiny wrapper for the Wordreference API

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/pcboy/wordref.svg)](https://travis-ci.org/pcboy/wordref)
[![Gem Version](https://badge.fury.io/rb/wordref.svg)](http://badge.fury.io/rb/wordref)
[![Code Climate](https://codeclimate.com/github/pcboy/wordref/badges/gpa.svg)](https://codeclimate.com/github/pcboy/wordref)

# Wordref

Wordref is a tiny gem to get a translation from Word reference (no API key needed).
You can translate words from one language to another ([Wordreference supported languages](https://github.com/pcboy/wordref/commit/25b4a4fef89e40cce6ae018501041aa6584538d8#diff-43114cec6cc4579b1d10b1d75031e5b5R52))

## Installation

Add this line to your application's Gemfile:

gem 'wordref'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wordref

## Usage

wr = Wordref::Wordref.new

wr.translate(from: 'en', to: 'fr', word: 'cat') # => "chat"

If you don't give the "from" parameter it'll automatically be set to english.
That's all.

## Contributing

1. Fork it
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 new Pull Request