A Ruby library that generates GitHub-like identicons
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib Revert to old-hash style (#3) Jun 26, 2015
.gitignore Initial commit Sep 5, 2013
LICENSE Update gemspec, Licence and Readme Jan 5, 2015
README.md Update README.md Aug 15, 2017
identicon.gemspec Version bump Jun 26, 2015

README.md

Identicon

Dependency Status

A Ruby library that generates GitHub-like identicons

Installation

Add it to your application's Gemfile:

gem 'identicon'

and run

$ bundle

or manually install through the command-line:

$ gem install identicon

Usage

Require it

require 'identicon'

And use data_url_for or file_for, as explained below:

data_url_for

This generates a data-url, so you can use it immediately, check it out:

Identicon.data_url_for "Whatever you want!"

You can also specify a image size and a background color:

Identicon.data_url_for "Whatever you want!", 128, [255, 255, 255]

This creates a 128x128px image, with a nice white background.

file_for

This generates and writes the result to a file. It's as easy as just making a data-url. Check it out:

Identicon.file_for "User's email? Username? Telephone?", "/path/to/the/image"

And, as you may guess, it also accepts the aforementioned parameters:

Identicon.file_for "User's email? Username? Telephone?", "/path/to/the/image", 128, [255, 255, 255]

Pull requests are welcome!

License

The MIT License (MIT)

Copyright (c) 2014-2017 Victor Gama

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.