A user-controlled dictionary plugin for Lita
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
locales
spec
.gitignore
.rspec
.rubocop.yml
.travis.yml
CONTRIBUTING.md
Gemfile
LICENSE
README.md
Rakefile
lita-wtf.gemspec

README.md

lita-wtf

Build Status MIT License RubyGems :: RMuh Gem Version Coveralls Coverage Code Climate Gemnasium

A user-controlled dictionary plugin for Lita.

Installation

Add lita-wtf to your Lita instance's Gemfile:

gem "lita-wtf"

Configuration

Optionally, you can add 'See Also' handlers

lita.config.wtf.see_also = ['merriam', 'urbandictionary']
lita.config.wtf.api_keys = {
  'merriam': 'abc123'
}

Usage

Set an entry:

lita define foo is something that you want to have defined
> foo is something that you want to have defined

Find an entry:

lita wtf is foo
> foo is something that you want to have defined

Optionally, get 'See Also' recommendations:

lita wtf is foo
> According to Merriam-Webster Collegiate Dictionary,
> foo is a mythical lion-dog used as a decorative motif
> in Far Eastern art
> To replace this with our own definition, type: define foo is <description>.

Development

This project uses dotenv to load sensitive variables for development. Create a .env file in your local copy with "MERRIAM_KEY="