diff --git a/README.md b/README.md index e71d0d2..a993668 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Nice KBDs -This Obsidian plugin automatically detects keyboard shortcuts and wraps them in tags. For example, ⌘ + A becomes ⌘ + A, making keyboard combinations clear and visually distinct (styles included). +This Obsidian plugin automatically detects keyboard shortcuts and wraps them in `` tags, indicating a 'keyboard input'. For example, `⌘ + A` becomes ⌘ + A, making keyboard combinations clear and visually distinct (styles included). -Additionally, this plugin introduces a unique Markdown syntax for manually specifying keyboard inputs. Using configurable wrapper characters, you can indicate key combos, like `«CMD»` CMD. +Additionally, this plugin introduces a unique Markdown syntax for manually specifying keyboard inputs: `«CMD»` will become CMD. ![Examples of key combos](demo.png)