Packages

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.

Current section

Files

Jump to
identicon_svg README.md
Raw

README.md

<img src="./assets/logo.png" width="100" height="100">
# IdenticonSvg
An Elixir library to generate identicons in SVG format, so they can be inlined in HTML.
## Installation
The package is [available in Hex](https://hex.pm/packages/identicon_svg) and can be installed by adding `identicon_svg` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:identicon_svg, "~> 0.8.0"}
]
end
```
## Configuration
No configuration required.
## Documentation
The docs can be found at <https://hexdocs.pm/identicon_svg>.
There's also a [discussion thread on elixirforum.com](https://elixirforum.com/t/identiconsvg-generates-identicons-in-svg-format-so-they-can-be-inlined-in-html/54557/1).
## TODO
- [x] Implement core functionality
- [x] Publish on hex.pm
- [x] Add background color functionality (split-complementary for automatic color-matching)
- [ ] Implement testing functions
- [ ] Set up CI