README.markdown in jamming-0.1.2 vs README.markdown in jamming-0.2.0
- old
+ new
@@ -22,9 +22,32 @@
This will write Em7#9, <em>The Jimi Hendrix Chord</em>, to <tt>/tmp/old_good_jimi.png</tt>:
+### Auto labels
+
+Jamming has an internal database with some chords that lets her auto-identify some chords. So, for example:
+
+ File.open("/tmp/a_major.png", 'w') do |f|
+ chord = Jamming::Chord.new("x-0-2-2-2-0")
+ f.write chord.to_png
+ end
+
+will generate an image like this:
+
+
+
+(Notice the _A_ label even if you never explicitly declared it.)
+
+If you'd like to override this behavior, pass `:label => nil` to the `to_png` method.
+
+If you find a chord that is not auto-labeled but you'd like it to be, please add it [to this file](https://github.com/andmej/jamming/blob/master/lib/jamming/dictionary.rb) and send a pull request.
+
+### Front-end
+
+Jamming is better served with a front-end that takes care of generating the images for you. Check out [this tiny Sinatra app](https://github.com/andmej/jamming_frontend) that does just that.
+
Thanks
---
Some code based on [ander/chords](https://github.com/ander/chords), thanks!
\ No newline at end of file