Skip to content

Commit 1039729

Browse files
committed
update README and keywords
1 parent 28c2323 commit 1039729

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Vue CLI Plugin Electron Builder
22

33
A Vue Cli 3 plugin for Electron with no required configuration that uses [Electron Builder](https://www.electron.build/) and [Electron Webpack](https://webpack.electron.build/).
4-
**IMPORTANT: Your app must be created with Vue-CLI 3 (vue create my-app), will not work with Vue-CLI 2 (vue init webpack my-app)**
4+
5+
**IMPORTANT: Your app must be created with Vue-CLI 3 (vue create my-app), will not work with Vue-CLI 2 (vue init webpack my-app)!**
56

67
## Quick Start:
78

@@ -34,6 +35,26 @@ or with NPM:
3435

3536
## Further Configuration:
3637

38+
### Folder Structure:
39+
40+
```
41+
├── dist/ # where electron-webpack outputs compiled files (this will overwrite normal build files)
42+
│ └── ...
43+
├── dist_electron/
44+
│ ├── [target platform]-unpacked # unpacked Electron app (main exe and supporting files)
45+
| ├── [application name] setup [version].[target binary (exe|dmg|rpm...)] # installer for Electron app
46+
│ └── ...
47+
├── src/
48+
| ├─── main/
49+
| | └── [main|index].[js|ts] # Electron entry file (for Electron's main process)
50+
| ├── [main|index].[js|ts] # your app's entry file (for Electron's render process)
51+
│ └── ...
52+
├── electron-builder.[json|yml] # electron-builder configuration options (can also be placed in package.json under the "build" key)
53+
├── electron-webpack.[json|yml] # electron-webpack configuration options (can also be placed in package.json under the "electronWebpack" key)
54+
├── package.json # your app's package.json file
55+
├── ...
56+
```
57+
3758
### CLI Options
3859

3960
When building your app, any arguments will be passed to electron-builder. To pass an argument/arguments to electron-webpack, place them after --webpack.
@@ -42,7 +63,7 @@ When building your app, any arguments will be passed to electron-builder. To pas
4263

4364
yarn build:electron [electron-builder options] --webpack [electron-webpack options]
4465

45-
### Configuration Files:
66+
### Configuration:
4667

4768
Initial configuration is already set for you in your app's package.json, but it you want to modify it:
4869

@@ -79,3 +100,7 @@ To see avalible options, check out [Electron Webpack Configuration Options](http
79100
As per Electron Webpack's documentation, they can be applied:
80101
81102
> Configurations can be applied in `package.json` at `electronWebpack` or in a separate `electron-webpack.(json|json5|yml)`.
103+
104+
#### Adding TypeScript Support:
105+
106+
When you invoke/add vue-cli-plugin-electron-builder, it will ask you if you use TypeScript and configure accordingly. However, if you answered no and decide to add TypeScript later on, you must install electron-webpack-ts: `yarn add electron-webpack-ts --dev` (or with NPM: `npm install --save-dev electron-webpack-ts`).

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
"electron",
88
"vue",
99
"cli",
10+
"vue-cli",
11+
"vue-cli-plugin",
1012
"webpack",
1113
"electron-builder",
1214
"electron-webpack"

0 commit comments

Comments
 (0)