README.md

# LZF

[![Build Status](https://travis-ci.org/joshuawscott/lzf_elixir.svg?branch=master)](https://travis-ci.org/joshuawscott/lzf_elixir) [![Hex.pm](https://img.shields.io/hexpm/v/plug.svg)]()

Pure elixir implementation of the LZF (de)compression algorithm

As of 0.1, this only supports decompression. PRs welcome :)

[Documentation](https://hexdocs.pm/lzf).

## Installation

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

```elixir
def deps do
  [
    {:lzf, "~> 0.1"}
  ]
end
```

## Testing

```
mix test
```