# CompaniesHouse

[![Test Status](https://github.com/sgerrand/ex_companies_house/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sgerrand/ex_companies_house/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/sgerrand/ex_companies_house/badge.svg?branch=main)](https://coveralls.io/github/sgerrand/ex_companies_house?branch=main)
[![Hex Version](https://img.shields.io/hexpm/v/companies_house.svg)](https://hex.pm/packages/companies_house)
[![Hex Docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/companies_house/)

An Elixir client for the [Companies House
API](https://developer.companieshouse.gov.uk/).

## Installation

The package can be installed by adding `companies_house`
to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:companies_house, "~> 0.2"}
  ]
end
```

## Development

### Requirements

- Elixir (see `.tool-versions` or `mix.exs` for version)
- [Homebrew](https://brew.sh) (for installing pre-commit hook dependencies)

### Setup

```shell
bin/setup
mix setup
```

`bin/setup` installs the pre-commit hook tools (`actionlint`, `check-jsonschema`, `lefthook`, `markdownlint-cli2`) and activates the hooks. `mix setup` fetches Elixir dependencies.

### Common commands

```shell
mix test          # Run tests
mix credo         # Lint
mix format        # Format code
mix coveralls     # Test coverage
```

## License

CompaniesHouse is [released under the MIT license](LICENSE).