README.md

# SearchEx

A full-text search engine written in pure Elixir.

## Installation

To install the escript:

`mix escript.install https://raw.githubusercontent.com/andyl/search_ex/master/search_ex`

The package can be added to your project from [Hex](https://hex.pm/docs/publish):

  1. Add `search_ex` to your list of dependencies in `mix.exs`:

    ```elixir
    def deps do
      [{:search_ex, "~> 0.0.1-alpha.1"}]
    end
    ```

  2. Ensure `search_ex` is started before your application:

    ```elixir
    def application do
      [applications: [:search_ex]]
    end
    ```