From 392461d253ddc9a5a2adb22a52723111e67ee548 Mon Sep 17 00:00:00 2001
From: Jomar Milan <jomarm@jomarm.tech>
Date: Tue, 5 Sep 2023 21:30:26 -0700
Subject: Initial commit

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c735aa8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# 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:
+
+```sh
+OSC 9 ; [message] ST
+```
+
+### Example commands
+
+```sh
+# creates a notification that says 'hello'
+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\\"
+```
-- 
cgit v1.3.1