From 2e319c8b98abe99ff963778d8f9d21fff09a9ccc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8D=89=E9=9E=8B=E6=B2=A1=E5=8F=B7?= <308487730@qq.com> Date: Sun, 13 Mar 2022 08:45:27 +0800 Subject: [PATCH] docs: update Usage --- README.md | 12 ++++++++++-- README.zh-CN.md | 28 ++++++++++++++++++---------- 2 files changed, 28 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d8cc12e..d9198b2 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,17 @@ - The extension is very flexible. -## Installation +## Usage -```bash +- The first way is to use scaffolding + +```sh +npm create electron-vite +``` + +- The second way is to clone the repository manually + +```sh # clone the project git clone https://github.com/caoxiemeihao/vite-react-electron.git diff --git a/README.zh-CN.md b/README.zh-CN.md index 794238d..14ca876 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -17,19 +17,27 @@ ## 运行 - ```bash - # clone the project - git clone https://github.com/caoxiemeihao/vite-react-electron.git +- 第一种方式是通过脚手架 - # enter the project directory - cd vite-react-electron +```sh +npm create electron-vite +``` - # install dependency - npm install +- 第二种方式是通过 clone 该仓库 - # develop - npm run dev - ``` +```sh +# clone the project +git clone https://github.com/caoxiemeihao/vite-react-electron.git + +# enter the project directory +cd vite-react-electron + +# install dependency +npm install + +# develop +npm run dev +``` ## 目录