Skip to content

Commit 575f452

Browse files
authored
Merge pull request #212 from drukepple/master
ReadMe update for actions
2 parents 30e0d21 + 69fdeb4 commit 575f452

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

Diff for: README.markdown

+19-15
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,24 @@ which are available on macOS 10.8 and higher.
77
## Caveats
88

99
* On macOS 10.8, the `-appIcon` and `-contentImage` options do nothing.
10-
This is because Notification Center on 10.8 _always_ uses the application’s own icon.
11-
10+
This is because Notification Center on 10.8 _always_ uses the application’s own icon.
11+
1212
You can do one of the following to work around this limitation on 10.8:
1313
- Use the `-sender` option to “fake it” (see below)
14-
- Include a build of terminal-notifier with your icon **and a different bundle identifier**.
14+
- Include a build of terminal-notifier with your icon **and a different bundle identifier**.
1515
(If you don’t change the bundle identifier, launch services uses a cached version of the icon.)
16-
16+
1717
However, you _can_ use unicode symbols and emojis! See the examples.
1818

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

2222
* If you intend to package terminal-notifier with your app to distribute it on the Mac App Store, please use 1.5.2; version 1.6.0+ uses a private method override, which is not allowed in the App Store Guidelines.
2323

24+
* To enable actions on the notification (the buttons that allow the user to select an option),
25+
open System Preferences > Notifications, select terminal-notifer in the sidebar, and select the "Alerts" alert style.
26+
![Enable alerts in System Preferences](assets/System_prefs.png)
27+
2428

2529
## Download
2630

@@ -99,7 +103,7 @@ $ terminal-notifier -group 'address-book-sync' -title 'Address Book Sync' -subti
99103

100104
### Options
101105

102-
At a minimum, you must specify either the `-message` , the `-remove`, or the
106+
At a minimum, you must specify either the `-message` , the `-remove`, or the
103107
`-list` option.
104108

105109
-------------------------------------------------------------------------------
@@ -127,8 +131,8 @@ The subtitle of the notification.
127131

128132
`-sound NAME`
129133

130-
Play the `NAME` sound when the notification appears.
131-
Sound names are listed in Sound Preferences.
134+
Play the `NAME` sound when the notification appears.
135+
Sound names are listed in Sound Preferences.
132136

133137
Use the special `NAME` “default” for the default notification sound.
134138

@@ -153,7 +157,7 @@ Does not work when `-reply` is used.
153157

154158
`-dropdownLabel VALUE` **[10.9+ only]**
155159

156-
Use the `VALUE` label for the notification’s dropdown menu actions
160+
Use the `VALUE` label for the notification’s dropdown menu actions
157161
(only when multiple `-actions` values are provided).
158162

159163
Does not work when `-reply` is used.
@@ -196,15 +200,15 @@ Example group IDs:
196200

197201
`-remove ID` **[required]**
198202

199-
Remove a previous notification from the `ID` ‘group’, if one exists.
203+
Remove a previous notification from the `ID` ‘group’, if one exists.
200204

201205
Use the special `ID` “ALL” to remove all messages.
202206

203207
-------------------------------------------------------------------------------
204208

205209
`-list ID` **[required]**
206210

207-
Lists details about the specified ‘group’ `ID`.
211+
Lists details about the specified ‘group’ `ID`.
208212

209213
Use the special `ID` “ALL” to list details about all currently active messages.
210214

@@ -229,11 +233,11 @@ Examples application IDs are:
229233

230234
`-sender ID`
231235

232-
Fakes the sender application of the notification. This uses the specified
233-
application’s icon, and will launch it when the notification is clicked.
236+
Fakes the sender application of the notification. This uses the specified
237+
application’s icon, and will launch it when the notification is clicked.
234238

235-
Because this option fakes the notification sender, it cannot be used with options
236-
like `-execute`, `-open`, and `-activate`, because they depend on the sender being
239+
Because this option fakes the notification sender, it cannot be used with options
240+
like `-execute`, `-open`, and `-activate`, because they depend on the sender being
237241
‘terminal-notifier’ to work.
238242

239243
For information on the `ID`, see the `-activate` option.
@@ -258,7 +262,7 @@ Specify an image `PATH` to attach inside of the notification.
258262

259263
`-open URL`
260264

261-
Open `URL` when the user clicks the notification. This can be a web or file URL,
265+
Open `URL` when the user clicks the notification. This can be a web or file URL,
262266
or any custom URL scheme.
263267

264268
-------------------------------------------------------------------------------

Diff for: assets/System_prefs.png

88.5 KB
Loading

0 commit comments

Comments
 (0)