From 8cc620ef8f741504780a9ac38a0e07a568a0700a Mon Sep 17 00:00:00 2001
From: daniel <github@dbauer.me>
Date: Sun, 25 May 2025 16:54:42 +0200
Subject: [PATCH] doc: add documentation on usage and link to hardware

---
 README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7c8b665..f158829 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
-# ZMK Module Template
+# ZMK Module: Corax Keyboard
 
-This repository contains a shield files for the [Corax Keyboard]() to allow users to build their own firmware.
+This repository contains shield files for the [Corax Keyboard](https://github.com/dnlbauer/corax-keyboard).
+It can be used to build the zmk firmware for the keyboard.
+
+**Example user config**: For a usage example, see my [Corax keyboard configuration](https://github.com/dnlbauer/corax-zmk-config)
+
+## Supported Keyboards:
+Supports the Corax56 and Corax54 keyboard variants.
+
+**Hardware**: [Corax Keyboard Repository](https://github.com/dnlbauer/corax-keyboard)
 
 ## Usage