Skip to content

Commit

Permalink
docs: add config example
Browse files Browse the repository at this point in the history
  • Loading branch information
develar committed Mar 29, 2017
1 parent 683d58c commit 55abc32
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
12 changes: 9 additions & 3 deletions docs/Options.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
electron-builder [configuration](#Config) can be defined
* in the `package.json` file of your project using the `build` key on the top level
* in the `package.json` file of your project using the `build` key on the top level:
```json
"build": {
"appId": "com.example.app"
}
```
* or through the `--config <path/to/yml-or-json5>` option (defaults to `electron-builder.yml` (or `json`, or [json5](http://json5.org))).
```yaml
appId: "com.example.app"
```
See [Config](#Config).
Most of the options accept `null` — for example, to explicitly set that DMG icon must be default volume icon from the OS and default rules must be not applied (i.e. use application icon as DMG icon), set `dmg.icon` to `null`.

Most of the options supports inheritance — `f`

## File Patterns

Hidden files are not ignored by default, but all files that should be ignored, are [ignored by default](#default-file-pattern).
Expand Down
2 changes: 1 addition & 1 deletion packages/electron-builder/src/metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ export interface Config extends PlatformSpecificBuildOptions {
readonly electronDownload?: any

/**
* Array of option objects. Order is important — first item will be used as a default auto-update server on Windows (NSIS).
* Array of option objects. Order is important — first item will be used as a default auto-update server.
* @see [Publish options](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#publish-options).
*/
readonly publish?: Publish
Expand Down

0 comments on commit 55abc32

Please sign in to comment.