# Significa Elixir Utils

A collection of Elixir functions, utilities and configurations used across Significa's projects.

[![significa-utils on hex.pm](https://img.shields.io/hexpm/v/significa_utils?style=flat)][hexpm]
[![significa-utils documentation](https://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)][hexdocs]

## Installation

[Available in Hex][hexpm], the package can be installed
by adding `significa_utils` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    # Check the releases page for the desired version (and use sigils accordingly, ex: "~>").
    {:significa_utils, ">= 0.0.1"}
  ]
end
```

Documentation can be found in [HexDocs][hexdocs].

## Contents

- Reusable `credo` config. 

  Create an alias in `mix.exs`

  ```elixir
    defp aliases do
    [
      credo: ["credo --config-file deps/significa_utils/.credo.exs"]
    ]
  end

  ```

  and run `mix credo` to use the credo config from significa_utils

[hexpm]: https://hex.pm/packages/significa_utils
[hexdocs]: https://hexdocs.pm/significa_utils