clean-up branch, update readme

1 files changed, 48 insertions, 14 deletions

diff --git a/README.md b/README.md
index 4cd9d8d..96c816b 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,56 @@
+# eiga's zmk-config
+
 **You probably reached this page by watching one of my [Ergo Split Keyb Videos](https://www.youtube.com/playlist?list=PL1E2ddJCbc13DvCGYXX9jVVX1BqNGKE5D).**
 
 This repository hosts my zmk-configs as seen on the YouTube videos linked above.
 
 Additionally, this repository contains alternative configurations meant to be used with an extra controller acting as a dongle. Pease refer to the [Dongle Flashing](https://github.com/eigatech/zmk-config#dongle-flashing) chapter for instructions.
 
-### Corne
+> [!NOTE]  
+> The configurations above are meant to be used with builds that are identical to the ones featured in the videos, otherwise they should be used as reference only.
+
+## Table of contents
+
+- Branches
+    - [Corne](#corne)
+    - [Charybdis](#charybdis)
+        - [Module documentation](#module-documentation)
+    - [TOTEM](#totem)
+- [Dongle Flashing](#dongle-flashing)
+- [Shops and Useful links](#shops-and-other-useful-links)
+
+
+## Corne
 
 - [Corne](https://github.com/eigatech/zmk-config/tree/corne)
 - [Corne Dongle](https://github.com/eigatech/zmk-config/tree/corne-dongle)
 
-### Charybdis
+> [!NOTE]  
+> Shield is configured for an earlier revision of Pete Johanson's [Corne Ultralight PCB](https://github.com/petejohanson/crkbd/tree/board/corne-ultralight), with nice!view support.
+
+## Charybdis
 
 - [Charybdis](https://github.com/eigatech/zmk-config/tree/charybdis-3.5)
 - [Charybdis Dongle](https://github.com/eigatech/zmk-config/tree/charybdis-dongle)
 
-### TOTEM
+### Module documentation
+
+- Charybdis
+    - [ZMK PMW3610 Driver](https://github.com/inorichi/zmk-pmw3610-driver)
+- Charybdis Dongle
+    - [ZMK Split Peripheral Input Relay](https://github.com/badjeff/zmk-split-peripheral-input-relay)
+    - [ZMK Input Behavior Listener](https://github.com/badjeff/zmk-input-behavior-listener)
+    - [ZMK PMW3610 Driver](https://github.com/badjeff/zmk-pmw3610-driver)
+
+> [!NOTE]  
+> Charybdis uses Inorichi's PMW3610 driver, while Charybdis Dongle leverages multiple modules written by badjeff.
+
+## TOTEM
 
 - [TOTEM](https://github.com/eigatech/zmk-config/tree/totem)
 - [TOTEM Dongle](https://github.com/eigatech/zmk-config/tree/totem-dongle)
 
-### Dongle Flashing
+## Dongle Flashing
 
 Dongle configs use Seeed Xiao Ble microcontrollers housed in a nifty 3D printed [case](https://www.printables.com/model/522586-seeed-xiao-ble-case).
 
@@ -30,16 +61,19 @@ Dongle configs use Seeed Xiao Ble microcontrollers housed in a nifty 3D printed
 5. Flash the first half with the `left` or `right` files.
 6. Repeat steps 4 and 5 for the other half.
 
-*When using both Nice!Nano and Seeed XIAO microcontrollers, make sure you are flashing them with the correct files!*
-
-### Notes
-
-The configurations above are meant to be used with builds that are identical to the ones featured in the videos, otherwise they should be used as reference only.
-
-### ZMK Modules used
+> [!WARNING]  
+> When using both Nice!Nano and Seeed XIAO microcontrollers, make sure you are flashing them with the correct files!
 
-[zmk-split-peripheral-input-relay](https://github.com/badjeff/zmk-split-peripheral-input-relay)
+## Shops and other useful links
 
-[zmk-input-behavior-listener](https://github.com/badjeff/zmk-input-behavior-listener)
+Kits, Prebuilts, Parts:
+- [kbd.news](https://kbd.news/vendors) - mechanical keyboard vendors list
+- [42keebs.eu](http://42keebs.eu/) - diy kits, including Corne, switches and other parts
+- [keeb.supply](https://keeb.supply/) - diy kits and prebuilts, including TOTEM, tools and other parts
+- [splitkb.com](https://splitkb.com/) - diy kits, including Corne, switches, tools and other parts
+- [bastardkb.com](https://bastardkb.com/) - diy kits and prebuilts, including Charybdis (wired only w/ qmk)
+- [typeractive.xyz](https://typeractive.xyz/) - diy kits and prebuilts, including Corne w/ nice!views, switches, tools and other parts
 
-[zmk-pmw3610-driver](https://github.com/badjeff/zmk-pmw3610-driver)
+Documentation and guides:
+- [ZMK Firmware Documentation](https://zmk.dev/docs)
+- [Eren's Wireless Charybdis Mini Guide](https://github.com/erenatas/charybdis-wireless-3x6)
\ No newline at end of file