doc fixes

This commit is contained in:
Loic Nageleisen 2013-10-22 17:42:07 +02:00
parent e2c2846b81
commit 6a9fa9bbf3

View file

@ -6,7 +6,7 @@ Integrates PDF generation into a Tilt flow
This gem depends on PDFKit, which in turn requires `wkhtmltopdf`. It is recommended to use the statically compiled version of the latter, as it is built against a patched QT that supports more features. This gem depends on PDFKit, which in turn requires `wkhtmltopdf`. It is recommended to use the statically compiled version of the latter, as it is built against a patched QT that supports more features.
## Usage as a Tilt ## Usage as a Tilt template
Add `tilt-pdf` to your Gemfile. Also add any template engine you may optionally want, such as `less` or `slim`. Add `tilt-pdf` to your Gemfile. Also add any template engine you may optionally want, such as `less` or `slim`.
@ -26,7 +26,7 @@ require 'tilt-pdf'
pdf = Tilt.new('foo.rpdf').render() pdf = Tilt.new('foo.rpdf').render()
``` ```
## Rails integration ## Rails and ActionView integration
Require `tilt/pdf/rails` if you want to set up and register `tilt-pdf` as an ActionView template handler. You can do it in an initializer, or straight from the Gemfile: Require `tilt/pdf/rails` if you want to set up and register `tilt-pdf` as an ActionView template handler. You can do it in an initializer, or straight from the Gemfile: