README.md

# Kaitai Struct: Runtime library for Elixir

Kaitai Struct is a declarative language used for describe various binary data structures, laid out in files or in memory: i.e. binary file formats, network stream packet formats, etc.

Further reading:

- [About Kaitai Struct](https://kaitai.io/)
- [About API implemented in this library](https://doc.kaitai.io/stream_api.html)

## Installation

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

```elixir
def deps do
  [
    {:kaitai_struct, "~> 0.1.0"}
  ]
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/katai_struct>.