Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
alloy committed Aug 24, 2013
1 parent 3b6e584 commit 4ab4b2e
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 13 deletions.
34 changes: 23 additions & 11 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
terminal-notifier is a command-line tool to send Mac OS X User Notifications,
which are available in Mac OS X 10.8.

It is currently packaged as an application bundle, because `NSUserNotification`
does not work from a ‘Foundation tool’. [radar://11956694](radar://11956694)

The Notification Center _always_ uses the application’s own icon, there’s
currently no way to specify a custom icon for a notification. The only way to
use this tool with your own icon is to include a build of terminal-notifier
with your icon instead.
## Caveats

This tool will be used by [Kicker](https://github.com/alloy/kicker) to show the
status of commands which are executed due to filesystem changes. (v3.0.0)
* It is currently packaged as an application bundle, because `NSUserNotification`
does not work from a ‘Foundation tool’. [radar://11956694](radar://11956694)

* The Notification Center _always_ uses the application’s own icon, there’s
currently no way to specify a custom icon for a notification. The only way to
use this tool with your own icon is to use the `-sender` option or include a
build of terminal-notifier with your icon and bundle identifier instead.


## Download

Prebuilt binaries, which are code-signed and ready to use, are available from
the [downloads section](https://github.com/alloy/terminal-notifier/downloads).
Prebuilt binaries are available from the
[releases section](https://github.com/alloy/terminal-notifier/releases).

Or if you want to use this from
[Ruby](https://github.com/alloy/terminal-notifier/tree/master/Ruby), you can
Expand Down Expand Up @@ -59,6 +59,9 @@ option or the `-list` option.

The message body of the notification.

Note that if this option is omitted and data is piped to the application, that
data will be used instead.

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

`-title VALUE`
Expand Down Expand Up @@ -120,6 +123,15 @@ Examples are:

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

`-sender ID`

Specifying this will make it appear as if the notification was send by that
application instead.

This is the only way

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

`-open URL`

Specifies a resource to be opened when the user clicks the notification. This
Expand All @@ -138,7 +150,7 @@ All the works are available under the MIT license. **Except** for
‘Terminal.icns’, which is a copy of Apple’s Terminal.app icon and as such is
copyright of Apple.

Copyright (C) 2012 Eloy Durán <eloy.de.enige@gmail.com>
Copyright (C) 2012-2013 Eloy Durán <eloy.de.enige@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
2 changes: 1 addition & 1 deletion Ruby/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ All the works are available under the MIT license. **Except** for
‘Terminal.icns’, which is a copy of Apple’s Terminal.app icon and as such is
copyright of Apple.

Copyright (C) 2012 Eloy Durán <eloy.de.enige@gmail.com>
Copyright (C) 2012-2013 Eloy Durán <eloy.de.enige@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
2 changes: 2 additions & 0 deletions Ruby/README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ TerminalNotifier.notify('Hello World', :activate => 'com.apple.Safari')
TerminalNotifier.notify('Hello World', :open => 'http://twitter.com/alloy')
TerminalNotifier.notify('Hello World', :execute => 'say "OMG"')
TerminalNotifier.notify('Hello World', :group => Process.pid)
TerminalNotifier.notify('Hello World', :sender => 'com.apple.Safari')
TerminalNotifier.notify('Hello World', :sound => 'default')

TerminalNotifier.remove(Process.pid)

Expand Down
4 changes: 3 additions & 1 deletion Terminal Notifier/AppDelegate.m
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ - (void)printHelpBanner;
"Use Console.app to view these logs.\n" \
"\n" \
"Note that in some circumstances the first character of a message has to be escaped in order to be recognized.\n" \
"An example of this is when using an open bracket, which has to be escaped like so: ‘\\[’.\n",
"An example of this is when using an open bracket, which has to be escaped like so: ‘\\[’.\n" \
"\n" \
"For more information see https://github.com/alloy/terminal-notifier.\n",
appName, appVersion, appName);
}

Expand Down

0 comments on commit 4ab4b2e

Please sign in to comment.