Skip to main content

README.md

# BoringAvatars

Direct port of [boring-avatars](https://github.com/boringdesigners/boring-avatars) to Elixir.

## Installation

Add `boring_avatars` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:boring_avatars, "~> 0.1.0"}
  ]
end
```

## Variants
<!-- tabs-open -->
### Bauhaus
![](./ground_truth/bauhaus.svg)
```elixir
BoringAvatars.bauhaus(name: "Clara Barton")
```

### Beam
![](./ground_truth/beam.svg)
```elixir
BoringAvatars.beam(name: "Clara Barton")
```

### Marble
![](./ground_truth/marble.svg)
```elixir
BoringAvatars.marble(name: "Clara Barton")
```

### Pixel
![](./ground_truth/pixel.svg)
```elixir
BoringAvatars.pixel(name: "Clara Barton")
```

### Ring
![](./ground_truth/ring.svg)
```elixir
BoringAvatars.ring(name: "Clara Barton")
```

### Sunset
![](./ground_truth/sunset.svg)
```elixir
BoringAvatars.sunset(name: "Clara Barton")
```
<!-- tabs-close -->