README.markdown in bruce-bumpspark-1.0.0 vs README.markdown in bruce-bumpspark-1.0.1
- old
+ new
@@ -5,25 +5,50 @@
inclusion in Rails projects (and standalone Ruby code).
This version of the library generates a transparent PNG.
Many thanks to the various collaborators:
+
* _why (concept, BMP implementation)
* jzp (png)
* MenTaLguY (transparency)
-== Note on Patches/Pull Requests
+## Usage
+
+### From Rails
+
+1. Include the gem as a dependency.
+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] >
+
+## From Ruby
+
+Simply create a `Bumpspark::Graph` instance and call `to_png` on it.
+
+ require 'bumpspark'
+
+ graph = Bumpspark::Graph.new [12, 34, 12, 42, 12, 23]
+
+ File.open('bumpspark.png', 'wb') do |file|
+ file.write graph.to_png
+ end
+
+## Note on Patches/Pull Requests
+Please check the TODO file for information on things that need doing.
+
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but
bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
-== Copyright
+## Copyright
Copyright (c) 2009 Bruce Williams, et al. See LICENSE for details.
[1]: http://redhanded.hobix.com/inspect/sparklinesForMinimalists.html