Skip to content

Commit

Permalink
Add description for --notify option
Browse files Browse the repository at this point in the history
  • Loading branch information
nao1215 committed Oct 18, 2022
1 parent ec0dcb8 commit db0eec6
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ If you are using oh-my-zsh, then gup has an alias set up. The alias is `gup - gi

![sample](./doc/img/sample.png)

gup command will notify you on your desktop whether the update was successful or unsuccessful after the update was finished.
![success](./doc/img/notify_success.png)
![warning](./doc/img/notify_warning.png)

# How to install
### Use "go install"
If you does not have the golang development environment installed on your system, please install golang from the [golang official website](https://go.dev/doc/install).
Expand Down Expand Up @@ -140,6 +136,14 @@ gup:INFO : create fish-completion file: /home/nao/.config/fish/completions/gup.f
gup:INFO : create zsh-completion file: /home/nao/.zsh/completion/_gup
```

### Desktop notification
If you use gup with --notify option, gup command notify you on your desktop whether the update was successful or unsuccessful after the update was finished.
```
$ gup update --notify
```
![success](./doc/img/notify_success.png)
![warning](./doc/img/notify_warning.png)

# Contributing
First off, thanks for taking the time to contribute! ❤️ See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
Contributions are not only related to development. For example, GitHub Star motivates me to develop!
Expand Down

0 comments on commit db0eec6

Please sign in to comment.