Inital port of xd84 (#5164)

[qmk_firmware.git] / keyboards / xd84 / readme.md

diff --git a/keyboards/xd84/readme.md b/keyboards/xd84/readme.md
new file mode 100644 (file)
index 0000000..38b4efc
--- /dev/null
+++ b/keyboards/xd84/readme.md
@@ -0,0 +1,23 @@
+# XD84
+
+![XD84](https://cdn.shopify.com/s/files/1/2711/4238/products/HTB17eeJSXXXXXbIXFXXq6xXFXXXp_1024x1024.jpg?v=1515505994)
+
+Compact With 84 Keys & RGB LED Underglow
+- Designed by Xiudi
+- Up to 87 keys
+  - iso and ansi support
+- Uses Kimera core
+
+Keyboard Maintainer: QMK Community  
+Hardware Supported: XD84  
+Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd84-xiudi-70-custom-keyboard-pcb)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make xd84:default
+
+Install examples:
+
+    make xd84:default:dfu
+
+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).