Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 1.73 KB

README.md

File metadata and controls

67 lines (47 loc) · 1.73 KB
Raw

Identicon

Built upon Ruby Matrix. Includes serveral renderers.

Example6 Example1 Example5 Example3 Example2 Example4

Installation

Add this line to your application's Gemfile:

gem 'identicon', github: 'max-power/identicon'

Usage

require 'identicon/svg'

Identicon.new('hi').to_svg

Advanced Usage

icon = Identicon.new("some_string", rows: 5, cols: 5)
icon.digest
icon.binary
icon.matrix
icon.color

Render an Identicon

require 'identicon/all'

icon.to_svg(options)
icon.to_png(options)
icon.to_html(options)
icon.to_text(options)

⬜⬜⬜⬜⬜
⬛⬛⬛⬛⬛
⬛⬜⬛⬜⬛
⬛⬛⬛⬛⬛
⬜⬛⬜⬛⬜

or use the Renderer:

Identicon::SVG.new(options).render(icon)
Identicon::PNG.new(options).render(icon)
Identicon::HTML.new(options).render(icon)
Identicon::Text.new(options).render(icon)

Render Parameters

  • invert Boolean: (default: false)
  • width Integer: Image width in Pixels (default: 240)
  • height Integer: Image height in Pixels (default: width)
  • padding Float(0..1): Padding as percentage of a block size

Contributing

  1. Fork it ( http://github.com/max-power/identicon/fork )
  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