summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index c735aa8..2b38411 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
# osc-notify
This is a [Tabby](https://github.com/Eugeny/tabby) plugin. It creates a system
-notification when an OSC 9 escape code sequence is printed. OSC 9 is in this
-format:
+notification when certain OSC escape code sequences are printed. The following
+OSC escape codes are supported:
```sh
OSC 9 ; [message] ST
+OSC 777 ; notify ; [title] ; [body] ST
```
### Example commands
@@ -16,4 +17,7 @@ printf "\033]9;hello\a"
# for tmux, use the passthrough escape sequence. allow-passthrough should be
# enabled
printf "\033Ptmux;\033\x1b]9;hello\x07\033\\"
+
+# creates a notification titled 'Build' with body 'Done'
+printf "\033]777;notify;Build;Done\a"
```