README.md

[![CircleCI](https://circleci.com/gh/jonathanchrisp/witaixir.svg?style=svg&circle-token=19f9caa01c6cef141df3bccf60a3996fde4d61ac)](https://circleci.com/gh/jonathanchrisp/witaixir)

# Witaixir
> Elixir API wrapper for Wit.ai

<p align="center">
  <img src="https://github.com/jonathanchrisp/witaixir/blob/master/wit.png?raw=true" alt="Wit" />
</p>

At present, this package is still in active development and not all endpoints have been implemented. Please review the outstanding tasks section defined below.

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

```elixir
def deps do
  [{:witaixir, "~> 0.0.1"}]
end
```

## Outstanding Tasks
### General
- [ ] Coverage reporting
- [ ] Documentation
- [ ] Type checking
### Endpoints
- [X] GET messages
- [ ] POST speech
- [ ] GET /entities
- [ ] POST /entities
- [ ] GET /entities/entity_id
- [ ] PUT /entities/entity_id
- [ ] DELETE /entities/entity_id
- [ ] POST /entities/entity_id/values
- [ ] DELETE /entities/entity_id/values
- [ ] POST /entities/:entity-id/values/:value-id/expressions
- [ ] DELETE /entities/:entity-id/values/:value-id/expressions
- [ ] POST /samples
- [ ] POST /apps