Elixicon

Easy Breezy Github-Style Default User Icons!

Elixicon allows you to quickly and easily generate default user identity avatar/icons similar to the default avatars you find on Github. You can generate these avatars randomly, or pass a string to derive the avatar image from it.

Like this:

Try It In the Shell for Hacking and Profit

Alternatively, if you'd like to tinker with the tool in the shell, you can clone this repository:

  git clone https://github.com/TimothyBritt/elixicon.git
  cd elixicon

Then fire up an iex repl with the library using:

  iex -S mix

Usage

Generate a random Elixicon with Elixicon.generate/0:

  Elixicon.generate

This will save your Elixicon to the filesystem. Most of the time you will probably prefer to have a more portable image, so you can also generate a random Base64 URL Elixicon Elixicon.generate_base64/0:

  Elixicon.generate_base64

Both of these functions use a randomly generated string to derive the Elixicon from. But, you can also pass a string, if you'd like to have a more predictable way to generate the images using generate/1 and generate_base64/1:

  Elixicon.generate("Timothy")
  Elixicon.generate_base64("Timothy")

Documentation

Currently, this library depends on the erlang :egd library, which is not currently pushed to hex. Because of this, Elixicon and it's documentation cannot be released into the hex ecosystem just yet. I am currently working on a fix for this.

Until then, please feel free to generate and browse the documentation locally:

  cd elixicon
  mix deps.get
  mix docs
  cd doc
  open index.html

Additionally, all the documentation is generated from @doc declarations in the lib/elixicon.ex file, so you can also browse the code and the tests.

Enjoy

You will have beautiful default user avatar icons that users will love!

Contribute

Have some ideas? Feedback? Something broken? No workie?

If you have a question, please create an issue and I'll have a look ASAP. If you'd like to contribute, please feel free to fork the project, make some changes and create a pull request. Please ensure that you are following some basic guidelines:

• Write tests. The code is well-covered and there are plenty of examples.
• Write documentation. The project uses ExDoc to automate the generation of documentation.
• Write examples and DocTests.
• Keep it clean.