Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
variadico committed Nov 8, 2015
1 parent 72503e4 commit cf8c375
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,29 @@ noti [options] [utility [args...]]
### Options
```
-t, -title
Set the notification title. If no arguments passed, default is "noti",
otherwise default is utility name.
Set the notification title. If no arguments passed, default is "noti",
otherwise default is utility name.
-m, -message
Set notification message. Default is "Done!"
Set notification message. Default is "Done!"
-s, -sound
Set notification sound. Default is Ping. Possible options are Basso,
Blow, Bottle, Frog, Funk, Glass, Hero, Morse, Ping, Pop, Purr, Sosumi,
Submarine, Tink. Check /System/Library/Sounds for available sounds.
Set notification sound. Default is Ping. Possible options are Basso,
Blow, Bottle, Frog, Funk, Glass, Hero, Morse, Ping, Pop, Purr, Sosumi,
Submarine, Tink. Check /System/Library/Sounds for available sounds.
-f, -foreground
Bring the terminal to the foreground.
Bring the terminal to the foreground.
-p, -pushbullet
Send a Pushbullet notification. Access token must be set in NOTI_PB
environment variable.
-v, -version
Print noti version and exit.
Print noti version and exit.
-h, -help
Display usage information and exit.
Display usage information and exit.
```

## Examples
Expand Down Expand Up @@ -78,3 +82,9 @@ Create a reminder to get back to a friend.
```
noti -t "Reply to Pedro" gsleep 5m &
```

Send a Pushbullet notification after tests finish.

```
noti -p go test ./...
```

0 comments on commit cf8c375

Please sign in to comment.