Create README.md

Author: 2skydev

README.md

@@ -0,0 +1,29 @@
+# electron-vite-react-ts-template
+
+A template for using electron quickly.
+
+## Overview
+
+- App framework: [`electron`](https://www.electronjs.org/)
+- App build tool: [`electron-builder`](https://www.electron.build/)
+- Bundle tool: [`vite`](https://vitejs.dev/)
+- Frontend framework: `react` + `typescript`
+- Code style: `eslint` + `prettier`
+- File-system based router: [`generouted`](https://github.com/oedotme/generouted)
+- CSS: [`styled-components`](https://styled-components.com/)
+- State management library: [`recoil`](https://hookstate.js.org/)
+- Date: [`dayjs`](https://day.js.org/)
+
+## Getting Started
+
+#### dev mode
+
+```bash
+yarn dev
+```
+
+#### vite & electron build
+
+```bash
+yarn build
+```