Skip to content
/ snoretoast Public

Commit cba371d

Browse files
committed
update readme
1 parent d3fb2c4 commit cba371d

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,38 @@ If your application does not have a shortcut in the startmenu yet please use the
99

1010

1111
----------------------------------------------------------
12-
13-
Welcome to SnoreToast 0.4.0.
14-
A command line application which is capable of creating Windows Toast notifications.
15-
16-
---- Usage ----
17-
SnoreToast [Options]
18-
19-
---- Options ----
20-
[-t] <title string> | Displayed on the first line of the toast.
21-
[-m] <message string> | Displayed on the remaining lines, wrapped.
22-
[-p] <image URI> | Display toast with an image, local files only.
23-
[-w] | Wait for toast to expire or activate.
24-
[-id] <id> | sets the id for a notification to be able to close it later.
25-
[-s] <sound URI> | Sets the sound of the notifications, for possible values see http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx.
26-
[-silent] | Don't play a sound file when showing the notifications.
27-
[-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.
29-
30-
-install <path> <application> <appID>| Creates a shortcut <path> in the start menu which point to the executable <application>, appID used for the notifications.
31-
32-
-v | Print the version and copying information.
33-
-h | Print these instructions. Same as no args.
34-
Exit Status : Exit Code
35-
Failed : -1
36-
Success : 0
37-
Hidden : 1
38-
Dismissed : 2
39-
Timeout : 3
40-
41-
---- Image Notes ----
42-
Images must be .png with:
43-
maximum dimensions of 1024x1024
44-
size <= 200kb
45-
These limitations are due to the Toast notification system.
46-
This should go without saying, but windows style paths are required.
12+
13+
Welcome to SnoreToast 0.5.0.
14+
A command line application which is capable of creating Windows Toast notifications.
15+
16+
---- Usage ----
17+
SnoreToast [Options]
18+
19+
---- Options ----
20+
[-t] <title string> | Displayed on the first line of the toast.
21+
[-m] <message string> | Displayed on the remaining lines, wrapped.
22+
[-p] <image URI> | Display toast with an image, local files only.
23+
[-w] | Wait for toast to expire or activate.
24+
[-id] <id> | sets the id for a notification to be able to close it later.
25+
[-s] <sound URI> | Sets the sound of the notifications, for possible values see http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx.
26+
[-silent] | Don't play a sound file when showing the notifications.
27+
[-appID] <App.ID> | Don't create a shortcut but use the provided app id.
28+
-close <id> | Closes a currently displayed notification, in order to be able to close a notification the parameter -w must be used to create the notification.
29+
30+
-install <path> <application> <appID>| Creates a shortcut <path> in the start menu which point to the executable <application>, appID used for the notifications.
31+
32+
-v | Print the version and copying information.
33+
-h | Print these instructions. Same as no args.
34+
Exit Status : Exit Code
35+
Failed : -1
36+
Success : 0
37+
Hidden : 1
38+
Dismissed : 2
39+
Timeout : 3
40+
41+
---- Image Notes ----
42+
Images must be .png with:
43+
maximum dimensions of 1024x1024
44+
size <= 200kb
45+
These limitations are due to the Toast notification system.
46+
This should go without saying, but windows style paths are required.

0 commit comments

Comments
 (0)