README.rdoc in check_writer-0.4.3 vs README.rdoc in check_writer-0.4.4
- old
+ new
@@ -55,11 +55,11 @@
and information displayed in the top and middle check stub.
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.
+#table method, set +stub_table_options+ with a hash of options. You can also use +stub_table_lambda+ to provide a block that is sent to the #table method.
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:
@@ -74,20 +74,17 @@
Signatures can be included on the checks by setting the +:signature_image_file+ option, which should
reference a JPG or PNG image. The recommended dimensions for a signature image are 175px x 40px.
If you need a second signature line on the check, +:second_signature_line+ to true.
-== Tests
+== Void and Blank Checks
-check_writer uses the appraisal gem to facilitate testing of various versions of prawn. To run the tests using appraisal:
+There are times where you may want to print a check that is clearly marked as a
+void check. Setting +void+ to a truish value will place "void" in place of the
+amount, check number, and the signature line.
- $ rake appraisal
-
-Note that if you need modify the Gemfile and need to re-bundle, you will also have to reinstall the appraisal gemfiles as well. To do this, your must first remove the +:development+ group from the Gemfile (i.e., the gems in the development group need to be bundled along with the rest of the gems, so they cannot be isolated in the dev group). Once you have done this, run:
-
- $ rake appraisal:install
-
-After appraisal installs its gemfiles, you can revert your Gemfile to as it was before.
+If you want the PDF to include everything except the lower one-third of the
+page (the actual check part), set +blank+ to a truish value.
== Contributing to check_writer
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.