docs(generic): document the new JS file option for config

electron · Dec 17, 2016 · 2d44c41 · 2d44c41
1 parent e57f3c7
commit 2d44c41
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -128,3 +128,15 @@ You can set `electronPackagerConfig` with **any** of the options from
 **NOTE:** The `afterCopy` and `afterExtract` options are mapped to `require`
 calls internally, so provide a path to a file that exports your hooks and they
 will still run.
+
+**NOTE:** You can also set your `forge` config property of your package.json to point to a JS file the exports the config object like so.
+
+```js
+{
+  ...
+  "config": {
+    "forge": "./forge.config.js"
+  }
+  ...
+}
+```