new readme

Author: JanLunge

README.md

@@ -1,10 +1,46 @@
-# vue-vite-electron
+# pog
+keyboard flashing utility
 
-An Electron application with Vue and TypesSript
+POG stands for Pog Open Gui
 
-## Recommended IDE Setup
+![version](https://badgen.net/badge/version/v0.0.9/green )
 
-- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+![logo](build/icon.png?raw=true)
+
+![preview](resources/pog-thumbnail.png?raw=true)
+
+## dependencies
+* node 16
+* yarn
+
+## Setup
+install everything with
+`yarn`
+then just run it with dev to start
+`yarn dev`
+
+
+# Tasks
+## urgent
+- [ ] boot.py generation
+- [ ] share pog.json files
+- [ ] use injection points from the pog.json for codeblocks
+- [ ] direct pin wiring support
+- [ ] bluetooth workflow
+
+## features
+- [x] dragging keys on the layout editor
+- [ ] language switcher for german and other layouts changing the labels on the keymap
+- [ ] modtap/tapdance/macros/sequences
+- [ ] encoder support direct pin click
+- [ ] way to handle differences between pog.json to kmk code
+- [ ] wiring preview
+
+## done
+- [x] Layout editor to replace KLE
+- [x] save pog.json (use as main storage for everything)
+- [x] adjust keymap when matrix changes
+- [x] drag and drop keys
 
 ## Project Setup