README.md in letter_avatar-0.0.3 vs README.md in letter_avatar-0.0.4
- old
+ new
@@ -11,22 +11,35 @@
sudo apt-get install -y advancecomp gifsicle jhead jpegoptim libjpeg-progs optipng pngcrush pngquant
Add this line to your application's Gemfile:
- gem 'letter_avatar'
+```ruby
+gem 'letter_avatar'
+```
And then execute:
$ 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'
+end
+```
+
## Usage
-TODO: Write usage instructions here
+```ruby
+LetterAvatar.generate 'ksz2k', 200
+=> "public/system/letter_avatars/2/K/87_178_230/200.png"
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)