branch: externals/sxhkdrc-mode
commit f4254c0ba84c80dffc35ef1240bb2faf899cc768
Author: Jonathan Neidel <jnei...@jneidel.com>
Commit: Jonathan Neidel <jnei...@jneidel.com>
Document usage in README
---
README.md | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/README.md b/README.md
index 610609f65e..b1bb6bf3c5 100644
--- a/README.md
+++ b/README.md
@@ -12,3 +12,22 @@ technicalities, read the man page `sxhkd(1)`.
+ GitLab: <https://gitlab.com/protesilaos/sxhkdrc-mode>
+ Backronym: Such Xenotropic Hot Keys Demonstrate Robustness and
Configurability ... mode.
+
+## Usage
+
+Install the mode and use with any `sxhkdrc` file:
+
+```elisp
+(use-package sxhkdrc-mode
+ :ensure t
+ :mode "sxhkdrc.*")
+```
+
+Restart the sxhkd daemon:
+```elisp
+; once
+(sxhkdrc-mode-restart)
+
+; automatically on file write
+(sxhkdrc-mode-auto-restart)
+```
