Readme

Author: suchmememanyskill

README.md

@@ -1,3 +1,43 @@
-# CYD-Klipper-Display
+![GitHub release (with filter)](https://img.shields.io/github/v/release/suchmememanyskill/CYD-Klipper)
+[![Donations](https://img.shields.io/badge/Support%20on-Ko--Fi-red)](https://ko-fi.com/suchmememanyskill)
 
-WIP!
+# CYD-Klipper
+An implementation of a Klipper status display on an ESP32 + screen. Uses Moonraker to fetch data.
+
+A simple and cheap solution to use a dedicated screen with Klipper, a 3d printing Firmware.
+
+![showcase_image](readme/PXL_20231113_171629383.jpg)
+
+### Required hardware
+
+A ESP32-2432S028R is required to run this project. You can find out where to buy these on the ["ESP32 Cheap Yellow Display"](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display#where-to-buy) repository.
+
+### Features
+- View printer status
+- View print progress
+- Start a print
+- Move the printer
+- Manage temperature
+- Extrude/Retract filament
+
+### Install
+
+[There is a web-based installer available. This is only supported on Chrome, Edge or Opera, and only on Desktop.](https://suchmememanyskill.github.io/CYD-Klipper/)
+
+On initial install, all data should be wiped. On updates, data should be able to be kept without issues.
+
+There are no 'over the air' updates. Each update has to be applied manually.
+
+### Screenshots
+(Quite literally shots of the screen. I'm sorry)
+
+-|- 
+:-:|:-:
+![1](readme/PXL_20231113_142717308.jpg)|![2](readme/PXL_20231113_171701876.jpg)
+![3](readme/PXL_20231113_171715809.jpg)|![4](readme/PXL_20231113_171724404.jpg)
+![5](readme/PXL_20231113_171751745.jpg)|![6](readme/PXL_20231113_171809315.jpg)
+
+
+### Credits
+- [xtouch](https://github.com/xperiments-in/xtouch)
+- [ESP32-Cheap-Yellow-Display](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display)