Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
variadico committed Sep 26, 2015
1 parent 9ae4a26 commit 6aedb93
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ noti [options] [utility [args...]]
```
-t, -title
Set the notification title. If no arguments passed, default is "noti",
else default is utility name.
otherwise default is utility name.
-m, -message
Set notification message. Default is "Done!"
Expand All @@ -37,6 +37,9 @@ noti [options] [utility [args...]]
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.
-v, -version
Print noti version and exit.
Expand Down Expand Up @@ -69,3 +72,9 @@ You can also add `noti` after a command, in case you forgot at the beginning.
```
clang foo.c -Wall -lm -L/usr/X11R6/lib -lX11 -o bizz; noti
```

Create a reminder to get back to a friend.

```
noti -t "Reply to Pedro" gsleep 5m &
```
18 changes: 7 additions & 11 deletions noti.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,9 @@ USAGE
noti [options] [utility [args...]]
OPTIONS
-f, -foreground
Bring the terminal to the foreground.
-t, -title
Set the notification title. If no arguments passed, default is "noti",
else default is utility name.
otherwise default is utility name.
-m, -message
Set notification message. Default is "Done!"
Expand All @@ -30,6 +27,9 @@ OPTIONS
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.
-v, -version
Print noti version and exit.
Expand All @@ -40,15 +40,11 @@ EXAMPLES
Display a notification when tar finishes compressing files.
noti tar -cjf music.tar.bz2 Music/
Display a notification when apt-get finishes updating on a remote server.
noti ssh [email protected] apt-get update
Set the notification title to "homebrew" and message to "Up to date" and
display it after Homebrew finishes updating.
noti -t "homebrew" -m "up to date" brew update
You can also add noti after a command, in case you forgot at the beginning.
clang foo.c -Wall -lm -L/usr/X11R6/lib -lX11 -o bizz; noti
Create a reminder to get back to a friend.
noti -t "Reply to Pedro" gsleep 5m &
`

const (
Expand Down

0 comments on commit 6aedb93

Please sign in to comment.