README.md in letter_avatar-0.0.5 vs README.md in letter_avatar-0.0.8

- old
+ new

@@ -1,17 +1,18 @@ # LetterAvatar Gem for creating letter avatar from user's name. -Code extracted from discourse source (thanks guys!) +Code extracted from discourse source (thanks guys!) - I needed this functionality in three projects, so here's the gem! :-) +[![Code Climate](https://codeclimate.com/github/ksz2k/letter_avatar/badges/gpa.svg)](https://codeclimate.com/github/ksz2k/letter_avatar) ## Installation System requirements - sudo apt-get install -y advancecomp gifsicle jhead jpegoptim libjpeg-progs optipng pngcrush pngquant + sudo apt-get install -y imagemagick Add this line to your application's Gemfile: ```ruby gem 'letter_avatar' @@ -22,11 +23,11 @@ $ bundle Or install it yourself as: $ gem install letter_avatar - + ## Configuration ```ruby LetterAvatar.setup do |config| config.cache_base_path='public/system/lets' # default is 'public/system' @@ -37,9 +38,23 @@ ```ruby LetterAvatar.generate 'ksz2k', 200 => "public/system/letter_avatars/2/K/87_178_230/200.png" ``` + +There's also helper for this. To use it, you need: + +* in your helper (eg. `ApplicationHelper`) or controller: + + ```ruby + include LetterAvatar::AvatarHelper + ``` + +* and in your view: + + ```ruby + letter_avatar_for('ksz2k', 200) + ``` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)