From 437388496cee5ed8582c0fed6359b02a58f010da Mon Sep 17 00:00:00 2001
From: Andrey Sitnik <andrey@sitnik.ru>
Date: Sat, 17 Feb 2024 22:23:03 +0100
Subject: [PATCH] Add more docs

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index 4c1b2b4..ce9de77 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ using keyboard.
 * Show/hide submenus of `role="menu"`.
 * Allows users to **override hotkeys**.
 * **1 KB** (minified and brotlied). No dependencies.
+* Vanilla JS and works with any framework including React, Vue, Svelte.
 
 ```jsx
 export const Button = ({ hokey, children }) => {
@@ -32,3 +33,58 @@ export const Button = ({ hokey, children }) => {
 ```sh
 npm install keyux
 ```
+
+Then add `startKeyUX` call with necessary features to main JS file.
+
+```diff
++ import {
++   getHotKeyHint,
++   hiddenKeyUX,
++   hotkeyKeyUX,
++   jumpKeyUX,
++   likelyWithKeyboard,
++   menuKeyUX,
++   pressKeyUX,
++   startKeyUX
++ } from 'keyux'
+
++ startKeyUX(window, [
++   hotkeyKeyUX(overrides),
++   menuKeyUX(),
++   pressKeyUX('is-pressed'),
++   jumpKeyUX(),
++   hiddenKeyUX()
++ ])
+
+  createRoot(root).render(<App>)
+```
+
+## Features
+
+### Hotkeys
+
+TODO
+
+### Pressed State
+
+TODO
+
+### Hotkeys Hint
+
+TODO
+
+### Hotkeys Override
+
+TODO
+
+### Menu
+
+TODO
+
+### Jumps
+
+TODO
+
+### Nested Menu
+
+TODO