README.rdoc in check_writer-0.1.1 vs README.rdoc in check_writer-0.2.0
- old
+ new
@@ -48,12 +48,17 @@
check.to_pdf # returns PDF file data
If you set the +with_stubs+ option to +true+ you'll get a bit of formatting
and information displayed in the top and middle check stub.
-Here's an example[https://github.com/rylwin/check_writer/raw/master/spec/assets/test-0.12.0.pdf].
+Here's an example[https://github.com/rylwin/check_writer/raw/master/spec/assets/with_stubs-0.12.0.pdf].
+It is also possible to include additional data in the stubs in the form of a table. If +with_stubs+ is true,
+then passing a 2D array to +stub_table_data+ will generate a table within each stub. To pass options to Prawn's
+#table method, set +stub_table_options+ with a hash of options.
+Example here[https://github.com/rylwin/check_writer/raw/master/spec/assets/with_stub_table_data-0.12.0.pdf].
+
Instead of just returning a PDF, you can access the Prawn PDF writer object
(Prawn::Document), which you can use to further customize the check or even
include multiple checks on the same PDF:
pdf = check1.to_prawn
@@ -82,9 +87,13 @@
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
== Copyright
+
+Font: The GnuMICR font is distributed under GPL, but please note the additional comments from
+the font creator in the
+GnuMICR README[https://github.com/rylwin/check_writer/tree/master/vendor/GnuMICR-0.30].
Copyright (c) 2012 Ryan Winograd. See LICENSE.txt for
further details.