From b7bbd626ebfdfc0b27b89d18abec5ba65310b783 Mon Sep 17 00:00:00 2001
From: koekeishiya <aasvi93@hotmail.com>
Date: Sun, 7 Jan 2018 19:51:44 +0100
Subject: #15 update readme and sample config

---
 examples/skhdrc | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

(limited to 'examples/skhdrc')

diff --git a/examples/skhdrc b/examples/skhdrc
index e6864e7..f10eb81 100644
--- a/examples/skhdrc
+++ b/examples/skhdrc
@@ -3,8 +3,12 @@
 #
 #                     A hotkey is written according to the following rules:
 #
-#                       hotkey   = <keysym> ':' <command> |
-#                                  <keysym> '->' ':' <command>
+#                       hotkey   = <mode> '<' <action> | <action>
+#
+#                       mode     = 'name of mode' | <mode> ',' <mode>
+#
+#                       action   = <keysym> ':' <command> | <keysym> '->' ':' <command>
+#                                  <keysym> ';' <mode>    | <keysym> '->' ';' <mode>
 #
 #                       keysym   = <mod> '-' <key> | <key>
 #
@@ -28,6 +32,24 @@
 #                                  prepend '\' at the end of the previous line.
 #
 #                                  an EOL character signifies the end of the bind.
+#
+#
+#  NOTE(koekeishiya): Modal operations
+#
+#                     defines a new mode 'switcher' with an on_enter command
+#                       :: switcher : chunkc border::color 0xff24ccaa
+#
+#                     defines a new mode named 'test'
+#                       :: test
+#
+#                     from 'default' mode, activate mode 'test'
+#                       cmd - x ; test
+#
+#                     from 'test' mode, activate mode 'default'
+#                       test < cmd - x ; default
+#
+#                     launch a new terminal instance when in either 'default' or 'test' mode
+#                       default, test < cmd - return : open -na /Applications/Terminal.app
 
 
 # open terminal, blazingly fast compared to iTerm/Hyper
-- 
cgit v1.2.3