readme.md

# ghibli

> [Studio Ghibli API](https://ghibliapi.herokuapp.com/#section/Studio-Ghibli-API) client

## Install

In your `mix.exs`:

```elixir
defp deps do
  [
    {:ghibli, "~> 1.0.0"}
  ]
end
```

Then run `mix deps.get`.

## API

Documentation is availbe in [HexDocs](https://hexdocs.pm/ghibli).

Each endpoint in the API (`Films`, `Locations`, `People`, `Species`, and `Vehicles`) has two functions: `all/0` and `get/1`. The former returns all of that resources, while the latter returns a resource by `id`. See the documentation for the API linked above for information about what is provided.

## License

MIT © [Juan Soto](https://juansoto.me)