From 27ece49156bef9e1dbe6f66006e748007a97a8e1 Mon Sep 17 00:00:00 2001 From: Frazer Smith Date: Mon, 5 Oct 2020 08:17:05 +0100 Subject: [PATCH] docs: spelling and grammar fixes --- CONTRIBUTING.md | 2 +- README.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f6e0a53..38920d68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Contributions are welcome and any help that can be offered is greatly appreciate Please take a moment to read the entire contributing guide. This repository uses the [Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow), -meaning that development should take place in `feat/` branches, with the `master` branch being kept in a stable state. +meaning that development should take place in `feat/` branches, with the `master` branch kept in a stable state. When you submit pull requests, please make sure to fork from and submit back to `master`. Other processes and specifications that are in use in this repository are: diff --git a/README.md b/README.md index babb4438..e2b99f1f 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ node-poppler's test scripts use yarn commands. ### Linux support Windows and OSX/Darwin binaries are provided with this repository. -For Linux users, you will need to download the `poppler-data` and `poppler-utils` binaries seperately. +For Linux users, you will need to download the `poppler-data` and `poppler-utils` binaries separately. An example of downloading the binaries on a Debian system: @@ -37,7 +37,7 @@ sudo apt-get install poppler-data sudo apt-get install poppler-utils ``` -Once they have been installed you will need to pass the `poppler-utils` installation directory in as parameters to an instance of the Poppler class: +Once they have been installed, you will need to pass the `poppler-utils` installation directory in as parameters to an instance of the Poppler class: ```js const { Poppler } = require('node-poppler'); @@ -56,7 +56,7 @@ const { Poppler } = require('node-poppler'); ### poppler.pdfToCairo -`options` object requires atleast one of the following to be set: `jpegFile`; `pdfFile`; `pngFile`; `psFile`; `svgFile`; `tiffFile`. +`options` object requires at least one of the following to be set: `jpegFile`; `pdfFile`; `pngFile`; `psFile`; `svgFile`; `tiffFile`. Example of an async await call poppler.pdfToCairo, to convert only the first and second page of a PDF file to PNG: @@ -78,7 +78,7 @@ console.log(res); ### poppler.pdfToHtml -Every field of the `options` object is entirely optional. +Every field of the `options` object is optional. Example of calling poppler.pdfToHtml with a promise: