From 1bbf9133bca753baa370977d1d248ec645c499b5 Mon Sep 17 00:00:00 2001
From: Nathan Witmer <nathan@zerowidth.com>
Date: Tue, 4 Jul 2023 11:11:57 -0600
Subject: [PATCH] Add espanso example config

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 77fb517..546803d 100644
--- a/README.md
+++ b/README.md
@@ -89,7 +89,42 @@ The sanitized issue title can be used for filenames. In a templater template for
 
 ### Auth issues
 
-If you're using a recent version of the GitHub CLI that uses the system keychain to store credentials, these helper functions may not work. If so, you can prepend the `PATH` to the user functions:
+If you're using a recent version of the GitHub CLI that uses the system keychain to store credentials, these helper functions may not work. If so, you can configure the `PATH` in the user functions. This assumes you've installed the GH CLI with homebrew:
 
 - `PATH=$PATH:/opt/homebrew/bin /opt/homebrew/bin/gh md link -n "$input"`
 - `PATH=$PATH:/opt/homebrew/bin /opt/homebrew/bin/gh md title -n --sanitize "$input"`
+
+## Using `gh-md` with [Espanso](https://espanso.org)
+
+An espanso config for generating links and references from the clipboard:
+
+```yaml
+matches:
+  - trigger: "//md"
+    replace: "{{output}}"
+    vars:
+      - name: clipboard
+        type: clipboard
+      - name: output
+        type: shell
+        params:
+          cmd: "gh md link {{clipboard}}"
+  - trigger: "//ml"
+    replace: "{{output}}"
+    vars:
+      - name: clipboard
+        type: clipboard
+      - name: output
+        type: shell
+        params:
+          cmd: "gh md link --simple {{clipboard}}"
+  - trigger: "//ir"
+    replace: "{{output}}"
+    vars:
+      - name: clipboard
+        type: clipboard
+      - name: output
+        type: shell
+        params:
+          cmd: "gh md ref {{clipboard}}"
+```