Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanbuchar authored Oct 2, 2020
1 parent 9deac0e commit 9fa6f92
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ await settings.get('color.code.rgb[1]');
// => 179
```

⚠ For Electron v10+, if you want to use electron-settings within a browser window, be sure to set the `enableRemoteModule` web preference to `true`. Otherwise you might get the error `Cannot read property 'app' of undefined`. See [#133](https://github.com/nathanbuchar/electron-settings/issues/133) for more info.

```js
new BrowserWindow({
webPreferences: {
enableRemoteModule: true // <-- Add me
}
});
```

### API Docs

API docs and can be found at [electron-settings.js.org](https://electron-settings.js.org).
Expand Down

0 comments on commit 9fa6f92

Please sign in to comment.