0.0
The project is in a healthy, maintained state
This is a simple Ruby implementation of Boring Avatars
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies
 Project Readme

BoringAvatar

Build Status

This is a Ruby implementation of Boring Avatars

Currently only supporting the following variants:

  • Bauhaus
  • Beam
  • Marble
  • Sunset

Installation

Add this line to your application's Gemfile:

gem "boring_avatar"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install boring_avatar

Usage

BoringAvatar::Bauhaus.new.generate
BoringAvatar::Beam.new(name: "John Doe").generate
BoringAvatar::Marble.new(name: "John Doe", size: 40).generate
BoringAvatar::Sunset.new(name: "John Doe", size: 40, colors: %w[#a3a948 #edb92e #f85931 #ce1836 #009989]).generate

There is also an online service should you wish to build a wrapper around the API.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/BoringAvatar.

License

The gem is available as open source under the terms of the MIT License.