README.md

# Elasticlunr

[![Test](https://github.com/heywhy/ex_elasticlunr/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/heywhy/ex_elasticlunr/actions)

This is port of [elasticlunr.js](https://github.com/weixsong/elasticlunr.js) project to Elixir.

Just click the button below to run it!

[![Run in Livebook](https://livebook.dev/badge/v1/blue.svg)](https://livebook.dev/run?url=https%3A%2F%2Fgithub.com%2Fheywhy%2Fex_elasticlunr%2Fblob%2Fmaster%2Fdocs.livemd)

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `elasticlunr` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:elasticlunr, "~> 0.4"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/elasticlunr](https://hexdocs.pm/elasticlunr).