diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 3d0c7ee..03f2b74 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -24,7 +24,7 @@ updates: - "eslint*" ignore: # Below are dependencies that have migrated to ESM - # in their next major version so we can't use them + # in their next major version so they cannot be updated - dependency-name: camelcase update-types: ["version-update:semver-major"] open-pull-requests-limit: 20 diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml index e61c010..cff7766 100644 --- a/.github/workflows/automerge.yml +++ b/.github/workflows/automerge.yml @@ -1,7 +1,7 @@ name: Automerge Dependabot PRs # **What it does**: Automatically merge Dependabot PRs that pass the CI workflow run. -# **Why we have it**: To keep our dependencies up-to-date, to avoid security issues. +# **Why we have it**: Keeps dependencies up-to-date, to avoid security issues. on: workflow_run: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f72387c..3488a05 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,7 +1,7 @@ name: CI -# **What it does**: Runs our tests. -# **Why we have it**: We want our tests to pass before merging code. +# **What it does**: Runs tests. +# **Why we have it**: Ensures tests pass before merging code. on: push: diff --git a/.npmignore b/.npmignore index ed00b3b..9bbaa03 100644 --- a/.npmignore +++ b/.npmignore @@ -1,4 +1,4 @@ -# `package.json` is published to npm, so everything we add is included in the installed tarball. +# `package.json` is published to npm, so everything added is included in the installed tarball. # Removing the `files` key and replacing it with this `.npmignore` saves some bytes, which # should improve installation performance slightly * diff --git a/README.md b/README.md index 9030b00..96b367b 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ npm i node-poppler ### Linux and macOS/Darwin support Windows binaries are provided with this repository. -For Linux users, you will need to download the `poppler-data` and `poppler-utils` binaries separately. +For Linux and Mac users, the `poppler-data` and `poppler-utils` binaries binary will need to be installed separately. An example of downloading the binaries on a Debian system: @@ -33,7 +33,7 @@ An example of downloading the binaries on a Debian system: sudo apt-get install poppler-data poppler-utils ``` -For macOS users, you can download the latest versions with [Homebrew](https://brew.sh/): +For macOS users, the binaries can be installed with [Homebrew](https://brew.sh/): ``` brew install poppler