diff --git a/README.md b/README.md index da8f78e..750757c 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ # electron-vite-vue +🥳 Really simple `Electron` + `Vue` + `Vite` boilerplate. + [![awesome-vite](https://awesome.re/mentioned-badge.svg)](https://github.com/vitejs/awesome-vite) [![Netlify Status](https://api.netlify.com/api/v1/badges/ae3863e3-1aec-4eb1-8f9f-1890af56929d/deploy-status)](https://app.netlify.com/sites/electron-vite/deploys) ![GitHub license](https://img.shields.io/github/license/caoxiemeihao/electron-vite-vue?style=flat) ![GitHub stars](https://img.shields.io/github/stars/caoxiemeihao/electron-vite-vue?color=fa6470&style=flat) ![GitHub forks](https://img.shields.io/github/forks/caoxiemeihao/electron-vite-vue?style=flat) +English | [简体中文](README.zh-CN.md) -**English | [简体中文](README.zh-CN.md)** - -🥳 Really simple `Electron` + `Vue` + `Vite` boilerplate. - -## Overview +## Features 📦 Out of the box 🎯 Based on [vue-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-vue-ts) template, less invasive -🌱 Simple directory structure,real flexible +🌱 Extensible, really simple directory structure 💪 Support Use Electron、Node.js API and in Renderer-process 🔩 Support C/C++ native addons 🖥 It's easy to implement multiple windows @@ -49,19 +48,20 @@ npm create electron-vite └── vite.config.ts ``` -## List the modules you may use as far as possible +## Examples -Used in `Main-process` 👉 [electron-vite-boilerplate](https://github.com/caoxiemeihao/electron-vite-boilerplate) +Used in Main-process 👉 [electron-vite-boilerplate](https://github.com/caoxiemeihao/electron-vite-boilerplate) -Used in `Renderer-process` 👉 [electron-vite-boilerplate/tree/nodeIntegration](https://github.com/caoxiemeihao/electron-vite-boilerplate/tree/nodeIntegration) +Used in Renderer-process 👉 [electron-vite-boilerplate/tree/nodeIntegration](https://github.com/caoxiemeihao/electron-vite-boilerplate/tree/nodeIntegration) -**ES Modules** +> List the modules you may use as far as possible +###### ES Modules - [execa](https://www.npmjs.com/package/execa) - [node-fetch](https://www.npmjs.com/package/node-fetch) - [file-type](https://www.npmjs.com/package/file-type) -**Native Addons(C/C++)** +###### Native Addons(C/C++) - [sqlite3](https://www.npmjs.com/package/sqlite3) - [serialport](https://www.npmjs.com/package/serialport)