README.md
# Avatarex
`Avatarex` is an elixir package for generating unique, reproducible Avatars.
The package is inspired by [Robohash](https://github.com/e1ven/Robohash)
Current Avatar sets include Birdy and Kitty created using images created
by David Revoy and used under CC-BY-4.0.
Images are generated using the [Image](https://github.com/elixir-image/image) elixir package.
Note: The package is currently under development.
## Installation
The package can be installed by adding `avatarex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:avatarex, "~> 0.2.0"}
]
end
```
Docs can be found at <https://hexdocs.pm/avatarex>.
## License
Avatarex source code is released under Apache License 2.0.
Check [LICENSE](LICENSE) files for more information.
### Acknowledgements
Many thanks to [Tomasz Sulima](https://github.com/Eiji7) for his rewrite proposal, code reviews, and design feedback.