# emoj

> Find relevant emoji from text

[![Build Status](https://travis-ci.org/sotojuan/emoj.svg?branch=master)](https://travis-ci.org/sotojuan/emoj)

Uses the API from this great article on [Emoji & Deep Learning](http://getdango.com/emoji-and-deep-learning.html). Check out the [Dango app](http://getdango.com) if you want something like this on your phone.

## Install

In your `mix.exs`:

```elixir
defp deps do
  [
    {:emoj, "~> 1.0.0"}
  ]
end
```

Then run `mix deps.get`.

## Usage

Check out [the HexDocs](https://hexdocs.pm/emoj) for more detailed information.

First of all, add Emoj to the `application` function in your `mix.exs`:

```elixir
def application do
  [applications: [:logger, :emoj]]
end
```

Then just use `Emoj.search` to search for relevant emoji:

```elixir
Emoj.search("I love chicken")
# {:ok, ["🐔", "🍗", "🐓", "🐥", "🐤", "🐣", "🍖", "😋", "😍", "👅"]}
```

Any possible error will result in an `{:error, reason}` tuple.

## Related

- [sindresorhus/emoj](https://github.com/sindresorhus/emoj) - Node and CLI version of this

## License

MIT © [Juan Soto](http://juansoto.me)