README.markdown in bruce-bumpspark-1.0.3 vs README.markdown in bruce-bumpspark-1.0.4

- old
+ new

@@ -1,27 +1,39 @@ # Bumpspark -A modified copy of _why's `bumpspark' code, originally discussed and -collaborated on at [RedHanded] [1], built out a gem suitable for -inclusion in Rails projects (and standalone Ruby code). - -This version of the library generates a transparent PNG. +Generate "bumpspark"-style sparklines from Ruby & Rails. -Many thanks to the various collaborators: +Note: This library is based on _why's `bumpspark' code, originally discussed and +collaborated on at [RedHanded] [1]. It has been refactored and built out as +a gem suitable for inclusion in Rails projects (and standalone Ruby code). +Bumpsparks are sparklines which show discrete data points and highlight +extremes. If you like Tufte and _why, you'll probably like these. + +## Credits + +Thanks to the various collaborators on _why's original post: + * _why (concept, BMP implementation) * jzp (png) * MenTaLguY (transparency) +## Installation + + sudo gem install bruce-bumpspark --source http://gems.github.com + ## Usage ### From Rails -1. Include the gem as a dependency. +1. Include the gem as a dependency in `config/environment.rb` + + config.gem 'bruce-bumpspark', :lib => 'bumpspark', :source => 'http://gems.github.com' + 2. Use `bumpspark_tag` from your views or helpers, passing it the data points you'd like graphed. - <%= bumpspark_tag [12, 34, 12, 42, 12, 23] %> + <%= bumpspark_tag [12, 34, 12, 42, 12, 23] %> ## From Ruby Simply create a `Bumpspark::Graph` instance and call `to_png` on it.