README.md

# ChineseDictionary

[![Build Status](https://travis-ci.org/JorisKok/chinese_dictionary.svg?branch=master)](https://travis-ci.org/JorisKok/chinese_dictionary)
[![Hex pm](http://img.shields.io/hexpm/v/chinese_dictionary.svg?style=flat)](https://hex.pm/packages/chinese_dictionary)

Docs: [https://hexdocs.pm/chinese_dictionary](https://hexdocs.pm/chinese_dictionary).


### How to use


```elixir
def deps do
  [
    {:chinese_dictionary, "~> 0.1.1"}
  ]
end
```

And we need to download the sqlite3 dictionary
```elixir
mix download_dictionary
```

Check the hex docs for further instructions