aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a1cf68
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# pbnotify
+
+pbnotify is a shell script for sending basic [PushBullet](https://www.pushbullet.com/) notifications.
+
+Usage: `pbnotify <title> <body>`
+
+In order to use the API, an API key is required. This script looks for it in the `$PB_API` environment variable, so set your environment accordingly.