diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 00d183c..639d271 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,7 +1,7 @@ on: # Allow manually triggering this workflow workflow_dispatch: - # run for all pull requests and pushes to certain branches + # Run for all pull requests and pushes to certain branches pull_request: push: branches: @@ -54,9 +54,9 @@ jobs: brew uninstall borgbackup-fuse - # Step is disabled because it times out on GH hosted runners - # bacause of a macOS security prompt - can only be done on - # selfhosted runners + # This step is disabled because it times out on GitHub-hosted runners + # because of a macOS security prompt — it can only be done on + # self-hosted runners. - name: Test mount command if: vars.TESTMOUNT run: | diff --git a/README.md b/README.md index 1f47441..1bdbe60 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BorgBackup [Homebrew](https://brew.sh/) tap -## Why install [Borg](https://www.borgbackup.org/) using this tap vs `brew install borgbackup`? +## Why install [Borg](https://www.borgbackup.org/) using this tap instead of `brew install borgbackup`? The `borgbackup-fuse` formula maintained in this tap depends on [macFUSE](https://osxfuse.github.io) and [llfuse](https://github.com/python-llfuse/python-llfuse/) which are required to mount repositories or archives using `borg mount`. @@ -15,15 +15,15 @@ brew install --cask macfuse brew install borgbackup/tap/borgbackup-fuse ``` -After that, borgbackup should upgrade automatically with homebrew when a new release is made. +After that, BorgBackup should upgrade automatically with Homebrew when a new release is made. ## For maintainers: How to make a new release? -1. Get new package URLs and SHAs from [PyPi](https://pypi.org/project/borgbackup/) +1. Get new package URLs and SHAs from [PyPI](https://pypi.org/project/borgbackup/) 2. ~~Lint `brew audit --strict Formula/borgbackup-fuse.rb`~~ 3. Install `brew install Formula/borgbackup-fuse.rb` 4. Test `brew test Formula/borgbackup-fuse.rb` ## Documentation -`brew help`, `man brew` or check [Homebrew’s documentation](https://docs.brew.sh). +Use `brew help`, `man brew`, or check [Homebrew’s documentation](https://docs.brew.sh).