README.md
# CompaniesHouse
An Elixir client for the [Companies House
API](https://developer.companieshouse.gov.uk/).
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `companies_house` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:companies_house, "~> 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/companies_house>.