<img src="./etc/assets/logo.png" width="100" height="100">

# Squircle

An Elixir library to generate squircles in SVG format that can be used to wrap an image, or as a mask for cropping SVG files.

## Installation

The package is [available in Hex](https://hex.pm/packages/squircle) and can be installed
by adding `squircle` to your list of dependencies in `mix.exs`:

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

## Configuration

No configuration required.

## Documentation

The docs can be found at <https://hexdocs.pm/squircle>.

This library is used by [IdenticonSvg](https://hexdocs.pm/identicon_svg) to convert square to squircled SVG identicons. See also [discussion thread on elixirforum.com](https://elixirforum.com/t/identiconsvg-generates-identicons-in-svg-format-so-they-can-be-inlined-in-html/54557/1).