README.md

# Hashvatar

Implementation of [Hashvatar by François Best](https://francoisbest.com/posts/2021/hashvatars).

## Installation

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

```elixir
def deps do
  [
    {:hashvatar, "~> 1.0.0"}
  ]
end
```

## Usage

Example:

```elixir
<Hashvatar.hashvatar
  identifier={@user.uuid}
  variant={:stagger}
  line_color="#fffaf0"
/>
```

Options:

- `identifier` (required): the identifier used to generate the hashvatar
- `variant` (default: `:normal`): the variant, can be one of: `:normal`, `:stagger`, `:gem`, `:spider`, `:flower`
- `line_color` (default: `"white"`): the line color (as a CSS-like value)
- `radius_factor` (default: `0.42`): a coefficient for the circles radii