Skip to content
/ snoretoast Public

Commit c3c171e

Browse files
committed
Update README.md
1 parent fcf706f commit c3c171e

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,27 @@ If your application does not have a shortcut in the startmenu yet please use the
1010

1111
----------------------------------------------------------
1212

13-
Welcome to SnoreToast.
14-
Provide toast with a message and display it via the graphical notification system.
15-
This application is inspired by https://github.com/nels-o/toaster and has the same syntax in some parts
13+
Welcome to SnoreToast 0.4.0.
14+
A command line application which is capable of creating Windows Toast notifications.
1615

1716
---- Usage ----
18-
toast [Options]
17+
SnoreToast [Options]
1918

2019
---- Options ----
2120
[-t] <title string> | Displayed on the first line of the toast.
2221
[-m] <message string> | Displayed on the remaining lines, wrapped.
2322
[-p] <image URI> | Display toast with an image, local files only.
2423
[-w] | Wait for toast to expire or activate.
25-
26-
The flowing arguments are only available in SnoreToast:
2724
[-id] <id> | sets the id for a notification to be able to close it later.
2825
[-s] <sound URI> | Sets the sound of the notifications, for possible values see http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx.
2926
[-silent] | Don't play a sound file when showing the notifications.
3027
[-appID] <App.ID> | Don't create a shortcut but use the provided app id.
28+
-close | Closes a currently displayed notification, must be used together with -id, in order to be able to close a notification the parameter -w needs to be used to create the notification.
3129

3230
-install <path> <application> <appID>| Creates a shortcut <path> in the start menu which point to the executable <application>, appID used for the notifications.
33-
-close | Closes a currently displayed notification, must be used together with -id, in order to be able to close a notification the parameter -w needs to be used to create the notification.
34-
[-v] | Print the version and copying information.
3531

36-
? | Print these instructions. Same as no args.
32+
-v | Print the version and copying information.
33+
-h | Print these instructions. Same as no args.
3734
Exit Status : Exit Code
3835
Failed : -1
3936
Success : 0

0 commit comments

Comments
 (0)