https://github.com/rbishop/identicon

An Elixir library for generating GitHub-like identicons
https://github.com/rbishop/identicon

Last synced: 2 months ago
JSON representation

An Elixir library for generating GitHub-like identicons

• Host: GitHub
• URL: https://github.com/rbishop/identicon
• Owner: rbishop
• License: other
• Created: 2015-05-26T03:45:18.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-13T16:41:41.000Z (over 7 years ago)
• Last Synced: 2024-08-09T16:52:33.521Z (5 months ago)
• Language: Elixir
• Size: 191 KB
• Stars: 27
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - An Elixir library for generating 5x5 identicons. (Images)
• fucking-awesome-elixir - identicon - An Elixir library for generating 5x5 identicons. (Images)
• awesome-elixir - identicon - An Elixir library for generating 5x5 identicons. (Images)

README

        
Identicon

=========

An Elixir library for generating GitHub-like symmetrical 5x5 identicons.

## Usage

Just pass a string or `char_list` to `Identicon.render/1`. You

will get back a Base64 encoded string representing your

identicon image.

```elixir

image = Identicon.render "Elixir"

# => a1070f60bb1e600..."

```

You can just keep using this in memory or write to file and decode into an

image:

```elixir

image = Identicon.render "Elixir"

:ok = File.write("Elixir.txt", image)

```

```bash

$ cat Elixir.txt | base64 -D -o elixir.png

```

## Todo

- [ ] Support various size/pixel count/background color identicons

- [x] Make the identicons symmetric like GitHub's (so cool!)

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## License

Identicon uses the same license as the Elixir programming language. See the

[license

file](https://raw.githubusercontent.com/rbishop/identicon/master/LICENSE) for

more information.