Skip to content

Commit 51cf429

Browse files
committed
update README
1 parent 1d7e31d commit 51cf429

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

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

3-
A Vue Cli 3 plugin for Electron with no required configuration
4-
3+
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/).
54
**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)**
65

76
## Quick Start:
@@ -49,12 +48,13 @@ Initial configuration is already set for you in your app's package.json, but it
4948

5049
### Electron Builder:
5150

52-
As per Electron Builder's documentation:
51+
To see avalible options, check out [Electron Builder Configuration Options](https://www.electron.build/configuration/configuration)
52+
53+
As per Electron Builder's documentation, they can be applied:
5354

54-
> electron-builder [configuration](https://www.electron.build/configuration/configuration#configuration) can be defined
55-
>
5655
> * in the `package.json` file of your project using the `build` key on the top level:
5756
>
57+
>
5858
> ```
5959
> "build": {
6060
> "appId": "com.example.app"
@@ -63,6 +63,7 @@ As per Electron Builder's documentation:
6363
>
6464
> * or through the `--config <path/to/yml-or-json5-or-toml>` option (defaults to `electron-builder.yml`(or `json`, or [json5](http://json5.org/), or [toml](https://github.com/toml-lang/toml))).
6565
>
66+
>
6667
> ```
6768
> appId: "com.example.app"
6869
> ```
@@ -73,6 +74,8 @@ As per Electron Builder's documentation:
7374
7475
### Electron Webpack:
7576
76-
As per Electron Webpack's documentation:
77+
To see avalible options, check out [Electron Webpack Configuration Options](https://webpack.electron.build/configuration)
78+
79+
As per Electron Webpack's documentation, they can be applied:
7780
7881
> Configurations can be applied in `package.json` at `electronWebpack` or in a separate `electron-webpack.(json|json5|yml)`.

0 commit comments

Comments
 (0)