Skip to content

Commit

Permalink
docs: spelling and grammar fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Frazer Smith committed Oct 5, 2020
1 parent 653cc22 commit 27ece49
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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');
Expand All @@ -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:

Expand All @@ -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:

Expand Down

0 comments on commit 27ece49

Please sign in to comment.