README.md in doc_juan-1.1.0 vs README.md in doc_juan-1.2.0

- old
+ new

@@ -15,11 +15,16 @@ config.secret = 'my-special-secret' end If you are using Rails an initializer would be the appropriate place for this. +### Authentication +If your site is behind HTTP Basic Authentication `DocJuan.config.username` and `DocJuan.config.password` is your friends. + +**BEWARE!** Setting these will append your credentials to every DocJuan url generated and, depending on how you use them, can be _fully visible to your users_. The authentication credentials is foremost available for testing in your staging environment. + ### Generating urls The `DocJuan.url` method generates a url to your Doc-Juan instance. It takes an url and a filename as the required arguments. You can supply an (optional) hash of options as the third argument. Valid options are: @@ -28,10 +33,11 @@ * `print_stylesheet` - If set to `true` the print stylesheet of the resource will be used. * `width` - Page width in millimeters. * `height` - Page height in millimeters. * `size` - a4, letter etc. This will be ignored if width and height is set. [List of sizes](http://stackoverflow.com/questions/6394905/wkhtmltopdf-what-paper-sizes-are-valid). * `orientation` - `landscape` or `portrait`. Defaults to portrait. -* `lowquality` - Renders the pdf in low quality if set to `true` +* `lowquality` - Renders the pdf in low quality if set to `true`. +* `format` - Output file format, `pdf` or `jpg`. Defaults to `pdf`. #### Example url = DocJuan.url 'http://example.com', 'example.pdf'