Skip to content

Commit

Permalink
Release v1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Zaid Kokaja committed Feb 12, 2020
1 parent 7221d3d commit 31fda68
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 14 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,19 @@
Brewlet
</h1>

<a href="https://github.com/zkokaja/Brewlet/releases/tag/v1.0">
<img src="images/release-badge.svg" alt="Release Version 1.0"/>
<a href="https://github.com/zkokaja/Brewlet/releases/tag/v1.1">
<img src="images/release-badge.svg" alt="Release Version 1.1"/>
</a>

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
<img src="images/brewlet-black.svg" width="16px" />
icon. If updates are available to be installed, the icon will become colored,
<img src="images/brewlet-color.svg" width="16px" /> , to get your attention.
<img src="images/brewlet-color.svg" width="16px" /> , 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.
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions images/release-badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 31fda68

Please sign in to comment.