Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README to mention --zap for Homebrew uninstall #1391

Merged
merged 1 commit into from
May 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,14 @@ That file can be backed up or transferred to other machines.

If you are using Rectangle v0.44+, you can also use the import/export button in the Preferences pane to share to your preferences and keyboard shortcuts across machines using a JSON file.

> [!NOTE]
> If you are having issues with configuration options persisting after an application restart and you've installed using Homebrew, you will need to uninstall and reinstall with the `--zap` flag.

```
brew uninstall --zap rectangle
brew install rectangle
```

## Uninstallation

Rectangle can be uninstalled by quitting the app and moving it to the trash. You can remove the Rectangle defaults from your machine with the following terminal command:
Expand All @@ -135,6 +143,13 @@ Rectangle can be uninstalled by quitting the app and moving it to the trash. You
defaults delete com.knollsoft.Rectangle
```

> [!TIP]
> If you are uninstalling after installing with Homebrew, you should include the `--zap` flag to ensure it removes the plist entries too.

```
brew uninstall --zap rectangle
```

---

## Contributing
Expand Down