Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheOneRing committed Jun 18, 2015
1 parent fcf706f commit c3c171e
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,27 @@ If your application does not have a shortcut in the startmenu yet please use the

----------------------------------------------------------

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

---- Usage ----
toast [Options]
SnoreToast [Options]

---- Options ----
[-t] <title string> | Displayed on the first line of the toast.
[-m] <message string> | Displayed on the remaining lines, wrapped.
[-p] <image URI> | Display toast with an image, local files only.
[-w] | Wait for toast to expire or activate.

The flowing arguments are only available in SnoreToast:
[-id] <id> | sets the id for a notification to be able to close it later.
[-s] <sound URI> | Sets the sound of the notifications, for possible values see http://msdn.microsoft.com/en-us/library/windows/apps/hh761492.aspx.
[-silent] | Don't play a sound file when showing the notifications.
[-appID] <App.ID> | Don't create a shortcut but use the provided app id.
-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.

-install <path> <application> <appID>| Creates a shortcut <path> in the start menu which point to the executable <application>, appID used for the notifications.
-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.
[-v] | Print the version and copying information.

? | Print these instructions. Same as no args.
-v | Print the version and copying information.
-h | Print these instructions. Same as no args.
Exit Status : Exit Code
Failed : -1
Success : 0
Expand Down

0 comments on commit c3c171e

Please sign in to comment.