diff --git a/README.md b/README.md index 4775bf1..d037731 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,16 @@ `vite 2` `vue 3` `electron 12` -## dev +## How to use +clone the repo via git and install dependencies: +```shell +git clone --depth 1 --single-branch https://github.com/hocili/vite-electron-typescript-template.git your-project-name +cd your-project-name +yarn +``` +## Starting Development +Start the app in the `dev` environment: ```shell yarn dev ``` @@ -11,8 +19,8 @@ yarn dev ```shell yarn electron:dev ``` -## build - +## Packaging for Production +To package apps for the local platform: ```shell yarn electron:build ```