Skip to content

Commit

Permalink
Add filename option to README
Browse files Browse the repository at this point in the history
  • Loading branch information
praveenperera committed Mar 22, 2017
1 parent 88bde4b commit 3ed008c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ to use wkhtmltopdf on systems that have no X installed, e.g. a server.

- master
- improve REAMDE
- add option to pick output pdf filename
- 0.3.5
- add `generate_binray` and `generate_binary!` that immediately return the
PDF binary instead of an `{:ok, filename}` tuple.
Expand Down Expand Up @@ -120,6 +121,8 @@ config :pdf_generator,
- `shell_params`: pass custom parameters to wkhtmltopdf. **CAUTION: BEWARE OF SHELL INJECTIONS!**
- `command_prefix`: prefix wkhtmltopdf with some command (e.g. `xvfb-run`, `sudo` ..)
- `delete_temporary`: immediately remove temp files after generation
- `filename` - filename you want for the output PDF (provide without .pdf extension),
defaults to a random string

# Documentation

Expand Down
5 changes: 0 additions & 5 deletions lib/pdf_generator.ex
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,12 @@ defmodule PdfGenerator do
## Options
* `:page_size` - output page size, defaults to "A4"
* `:open_password` - password required to open PDF. Will apply encryption to PDF
* `:edit_password` - password required to edit PDF
* `:shell_params` - list of command-line arguments to wkhtmltopdf
see http://wkhtmltopdf.org/usage/wkhtmltopdf.txt for all options
* `:delete_temporary` - true to remove the temporary html generated in
the system tmp dir
* `:filename` - filename you want for the output PDF (provide without .pdf extension),
defaults to a random string
Expand Down

0 comments on commit 3ed008c

Please sign in to comment.