diff --git a/README.md b/README.md index bad4385..3f85f9e 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,19 @@ Brewlet - - Release Version 1.0 + + Release Version 1.1 The missing menulet for [brew.sh]. -This menulet makes it easier to work with [brew.sh]. For example, you need to +This menulet makes it easier to use [brew.sh]. For example, you need to manually check if some of your packages can be updated. With Brewlet it's easy: if everything is working swimmingly, then you'll see the normal shadow icon. If updates are available to be installed, the icon will become colored, - , to get your attention. + , to get your attention – +along with a notification if you wish. Once clicked, you'll be able to take upgrade your packages, among other options. In addition, Brewlet will periodically check the status of packages in the background, so you don't have to. @@ -34,18 +35,24 @@ or direct link I am currently working on adding more features, listed in order of priority here: +- Show list of outdated packages +- Ability to handle casks - Add preferences window for time intervals -- Ability to handle casks as well -- Notifications for available updates -- Better timer handling (missed fires) - Ability to install brew if not found - Look for missing packages -- Temporarily disable timers -- What if upgrading requires interaction? ## Developer +Contributions are welcome! + +You can look for logged messages and errors with the Console app, or this command +(replacing with your PID of course): + +```bash +$ log show --predicate 'processID == 6259' --info +``` + To generate images of different sizes, use [Inkscape] on the command line: ```bash @@ -61,11 +68,14 @@ $ inkscape --export-type="png" \ Because this app is closely tied to `brew.sh`, I used their icon as a template. I also decided to adopt their choice of license: BSD 2-Clause "Simplified" License. -## Security +## Security & Permissions Brewlet needs to be able to access the `brew.sh` shell script to get information -and take action on your behalf. And access to your Downloads folder to export -a list of packages. +and take action on your behalf. And access to write to your Downloads folder +when exportng a list of packages. + +Brewlet needs permission to send you notifications when updates are available, +and when unexpected errors occur. [brew.sh]: https://brew.sh [Inkscape]: https://inkscape.org diff --git a/images/release-badge.svg b/images/release-badge.svg index e4c6415..86c6ddc 100644 --- a/images/release-badge.svg +++ b/images/release-badge.svg @@ -14,7 +14,7 @@ release release - v1.0 - v1.0 + v1.1 + v1.1