rename to cg_swap and added docs

2022-04-08 22:09:55 -05:00
parent 3f0283422d
commit 6002ad33e1
2 changed files with 14 additions and 1 deletions
--- a/docs/cg_swap.md
+++ b/docs/cg_swap.md
@@ -0,0 +1,13 @@
+# Ctrl Gui Swap
+This module allows to swap Ctrl with Gui and vice versa. This will reset on restart to the default implementation
+
+## Enabling the module
+```python
+from kmk.module.cg_swap import CgSwap
+# cg_swap disabled on startup
+cg_swap = CgSwap()
+# cg_swap enabled on startup
+# cg_swap = CgSwap(true)
+keyboard.modules.append(cg_swap)
+
+```