aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGabriel Handford2016-05-19 11:34:14 -0700
committerGabriel Handford2016-05-19 11:34:14 -0700
commit17405ab3fd75474562f921a58715a50ca28f1b5a (patch)
treeb8d0cd924f25bcf1a2f99fbe99fd56f1dffc5308
parent32894e6239f4d92e5b94da58ea04a7da2a3ea9d9 (diff)
downloadgo-notifier-17405ab3fd75474562f921a58715a50ca28f1b5a.tar.bz2
Updating docsHEADmaster
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index a6b3eb3..56adce6 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,31 @@ go install github.com/keybase/go-notifier/notifier
If you need alert style (actionable) notifications (on OS X), you need to include an Info.plist
in the binary and sign it. You can look at `build_darwin.sh` on how to do this.
+### Examples (OS X)
+
+#### Notification with single action
+
+```
+notifier --title="Hi" --message="Test message" --bundle-id=keybase.Electron --timeout=20 --action=Close
+```
+
+If action is chosen, you get output (stdout):
+```
+{"type":"action","action":"Close"}
+```
+
+If the notification contents are clicked,
+```
+{"type":"clicked"}
+```
+
+#### Notification with multiple actions
+
+```
+notifier --title="Hi" --message="Test message" --bundle-id=keybase.Electron --timeout=20 --action=Close --action="Install" --action="Ignore"
+```
+
+
### Resources
Follows similar requirements of [node-notifier](https://github.com/mikaelbr/node-notifier),