# IdenticonSvg v1.0.0 - Table of Contents

> An Elixir library to generate Github-style identicons in SVG format with a small file size, so that they can be inlined in HTML, optionally cropped to a squircle.

## Pages

- [README](readme.md)

## Modules

- [IdenticonSvg](IdenticonSvg.md): Generate GitHub-style identicons as complete SVG documents.
- [IdenticonSvg.Color](IdenticonSvg.Color.md): Module of `IdenticonSvg` that contains functions related to handling colors.

- [IdenticonSvg.Draw](IdenticonSvg.Draw.md): Module of `IdenticonSvg` that contains functions related to drawing SVG elements and composing the SVG output of the requested identicon.

- [IdenticonSvg.EdgeCleaner](IdenticonSvg.EdgeCleaner.md): Module incorporating functions that remove internal edges shared between squares grouped into a polygon.

- [IdenticonSvg.EdgeTracer](IdenticonSvg.EdgeTracer.md): Module that contains functions for tracing edges around merged squares of the identicon's grid.

- [IdenticonSvg.Identicon](IdenticonSvg.Identicon.md): Defines the `%Identicon{}` struct used by the functions of the main
module to gradually process and generate an identicon.

- [IdenticonSvg.PolygonReducer](IdenticonSvg.PolygonReducer.md): Module incorporating functions that find neighboring squares and use `Enum.reduce/3` to group them into polygons.

## Mix Tasks

- [mix profile](Mix.Tasks.Profile.md): Profile identicon generation performance across sizes and options.

