summaryrefslogtreecommitdiffstats
path: root/keyboards/staryu/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/staryu/readme.md')
-rw-r--r--keyboards/staryu/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/staryu/readme.md b/keyboards/staryu/readme.md
new file mode 100644
index 000000000..bca7482bc
--- /dev/null
+++ b/keyboards/staryu/readme.md
@@ -0,0 +1,15 @@
+# Staryu
+
+![Staryu](https://i.imgur.com/obcCpZN.jpg)
+
+A 5 key macropad, designed by Kai and sold by KPRepublic.
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: Staryu (only the non-lite version has been tested)
+Hardware Availability: [AliExpress](https://www.aliexpress.com/item/Staryu-Mini-Macro-Pad-custom-keyboard-by-tkg-kai-Mini-macro-pad-mechanical-keyboard-5-keys/32817560746.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make staryu:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.