From 6002ad33e14904032195657c6afa27083cea6f47 Mon Sep 17 00:00:00 2001
From: Syed Hussaini <masiullah@gmail.com>
Date: Fri, 8 Apr 2022 22:09:55 -0500
Subject: [PATCH] rename to cg_swap and added docs

---
 docs/cg_swap.md                          | 13 +++++++++++++
 kmk/modules/{swap_keys.py => cg_swap.py} |  2 +-
 2 files changed, 14 insertions(+), 1 deletion(-)
 create mode 100644 docs/cg_swap.md
 rename kmk/modules/{swap_keys.py => cg_swap.py} (98%)

diff --git a/docs/cg_swap.md b/docs/cg_swap.md
new file mode 100644
index 0000000..115688c
--- /dev/null
+++ 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)
+
+```
diff --git a/kmk/modules/swap_keys.py b/kmk/modules/cg_swap.py
similarity index 98%
rename from kmk/modules/swap_keys.py
rename to kmk/modules/cg_swap.py
index 9c1cf52..9dbfbc7 100755
--- a/kmk/modules/swap_keys.py
+++ b/kmk/modules/cg_swap.py
@@ -2,7 +2,7 @@ from kmk.keys import KC, ModifierKey, make_key
 from kmk.modules import Module
 
 
-class SwapKeys(Module):
+class CgSwap(Module):
     # default cg swap is disabled, can be eanbled too if needed
     def __init__(self, cg_swap_enable=False):
         self.cg_swap_enable = cg_swap_enable