jitterbug 0.2.0 → 0.3.0

data/README.markdown

@@ -1,19 +1,50 @@
 # Jitterbug: A just-in-time image creator for pretty text headers
 
-Jitterbug provides on-demand text header images using the font of your choice. On its first request, Jitterbug creates the requested header graphic. Then, and on subsequent requests, it returns an html image tag pointing to the header graphic file.
+Jitterbug provides on-demand text header images using the font of your choice. On the first request, Jitterbug creates the requested header graphic and returns its image tag. On subsequent requests it returns the image tag of the already-created graphic.
+
+## Usage
+
+Pass the `jitterbug` helper a string to convert into a header graphic. Optionally pass in any other parameters that differ from the defaults.
+
+    <%= jitterbug 'Default' %>
+    <%= jitterbug('Forty Two', :size => 42) %>
+    <%= jitterbug(t('whole_enchilada'), :background => '#fff', :color => 'green', :font => 'Yummy.otf', :font_dir => '/fonts/', :format => 'gif', :img_path => '/images/headers/', :size => 64, :width => 240) %>
+
+## Dependencies
+
+Jitterbug uses `Imagemagick` to build the header images. It needs to be installed on your development and production machines, as do any fonts that you're using.
 
 ## Quick Links
 
- * http://github.com/flyingsaucer/jitterbug
+ * [github.com/flyingsaucer/jitterbug](http://github.com/flyingsaucer/jitterbug)
+ * [imagemagick.org](http://www.imagemagick.org/script/index.php)
 
-## Installing
+## Installation
 
-    # Install the gem:
     sudo gem install jitterbug
-    
-## Using in an existing project
 
+In your `config/environment.rb` file:
+
+    Rails::Initializer.run do |config|
+      config.gem "jitterbug", :source  => 'http://gemcutter.org/'
+    end
+
+## Configuration
+
+Define your global configuration in `config/jitterbug.yml`. The following sample contains Jitterbug's built in defaults. Note that the asterisk default for the font causes Jitterbug to use the first font that it finds in the font_dir folder.
 
+    development:   &defaults
+      background:  transparent
+      color:       white
+      font:        *
+      font_dir:    /lib/fonts/
+      format:      png
+      img_path:    /content/jitterbug/
+      size:        14
 
-### Default configs
+    test:
+      <<:          *defaults
+      img_path:    /tmp/jitterbug/
 
+    production:
+      <<:          *defaults

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/jitterbug.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jitterbug}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Sessions", "Seth Engelhard"]

data/lib/jitterbug.rb

@@ -19,9 +19,9 @@ module Jitterbug
         -font #{Jitterbug::Fonts.find(options[:font_dir], options[:font])} \
         -pointsize #{options[:size]} -blur 0x.3 #{caption} #{path}`
     end
-    image_tag "/#{options[:img_path]}/#{hash}.#{options[:format]}".gsub('//', '/'),
-              :class => (['jitterbug'] << options[:class]).compact.join(' '),
-              :alt => label
+    img_src   = "/#{options[:img_path]}/#{hash}.#{options[:format]}".gsub('//', '/')
+    img_class = (['jitterbug'] << options[:class]).compact.join(' ')
+    %Q{<img src="#{img_src}" class="#{img_class}" alt="#{label}" />}
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jitterbug
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Chris Sessions