From 24bcd2e6f6f87290e8f22a86771157daf2823764 Mon Sep 17 00:00:00 2001 From: Emric Date: Fri, 6 Dec 2019 09:54:31 +0000 Subject: [PATCH] Document file extension option When converting a PDF, file extension can be chosen. This was however not documented in the README. This commit adds that documentation. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 61b0b88..fac0f9a 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ var pdfImage = new PDFImage("/tmp/slide.pdf", { }); pdfImage.convertFile().then(function (imagePaths) { - // /tmp/slide.png + // /tmp/slide.png }); ``` @@ -87,3 +87,11 @@ var pdfImage = new PDFImage(pdfPath, { } }); ``` + +You can specify what file extension to use with the `convertExtension` option. + +```javascript +var pdfImage = new PDFImage(pdfPath, { + convertExtension: "jpg", +}); +```