summaryrefslogtreecommitdiff
path: root/keyboards/keysofkings/twokey/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/keysofkings/twokey/readme.md')
-rw-r--r--keyboards/keysofkings/twokey/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/keysofkings/twokey/readme.md b/keyboards/keysofkings/twokey/readme.md
new file mode 100644
index 0000000000..18394f8f80
--- /dev/null
+++ b/keyboards/keysofkings/twokey/readme.md
@@ -0,0 +1,16 @@
+# TWOKEY
+
+![Twokey](https://i.imgur.com/UiLwPldl.jpeg)
+
+A Two Key mini keyboard with Rotary Encoder/Switch along with Backlight keys, RGB Underglow, and Piezo Buzzer. Supports Cherry, Choc, Matias switches.
+
+* Keyboard Maintainer: Keys of Kings
+* Keyboard Designer: King Icewind
+* Hardware Supported: Twokey PCB, Pro Micro
+* Hardware Availability: www.keysofkings.com
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keysofkings/twokey:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).