@devisfuture/electron-modular 1.1.7 → 1.1.9

package/README.md

@@ -40,6 +40,8 @@ Instead of wrestling with service initialization order or managing global state,
 
 A small example app demonstrating how to use this package is available at [trae-op/quick-start_react_electron-modular](https://github.com/trae-op/quick-start_react_electron-modular). It contains a minimal React + Electron project that shows module registration, IPC handlers and window managers in action — check its README for setup and run instructions.
 
+For a full starter application with complete settings and built-in features, see the boilerplate at [trae-op/electron-modular-boilerplate](https://github.com/trae-op/electron-modular-boilerplate). This repo contains a ready-to-use React + Electron starter demonstrating advanced integrations (OAuth with Google & GitHub, auto-update support, authentication flows), build and dev scripts, and sensible defaults to help you get started quickly — see its README for details and setup instructions.
+
 ---
 
 ## Installation
@@ -342,6 +344,30 @@ export class UserWindow implements TWindowManager {
 }
 ```
 
+### Preload script — default behavior 🔧
+
+By default the framework sets the BrowserWindow's `webPreferences.preload` to the package `preload` file located in the `distMain` folder you configured via `initSettings`. Concretely this resolves to `<app path>/<distMain>/preload.cjs` (production), and the development build is resolved appropriately when running in dev mode.
+
+By default the source `preload` file should be placed at `src/main/preload.cts` in your project; it will be compiled/bundled to `preload.cjs` in your configured `distMain` folder during the build step.
+
+If you need a custom preload for a specific window, set `options.webPreferences.preload` on the `@WindowManager` config — this will override the framework default:
+
+```ts
+@WindowManager<TWindows["userProfile"]>({
+  hash: "window:user-profile",
+  isCache: true,
+  options: {
+    width: 600,
+    height: 400,
+    webPreferences: {
+      preload: '/absolute/or/relative/path/to/custom-preload.js'
+    }
+  },
+})
+```
+
+> Note: the custom `preload` you provide will override the default `preload` the package injects.
+
 ### Lifecycle Hooks (Window & WebContents events) ✅
 
 The window manager supports lifecycle hooks by naming methods on your class following a simple convention:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devisfuture/electron-modular",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "Core module system, DI container, IPC handlers, and window utilities for Electron main process.",
   "type": "module",
   "main": "./dist/index.js",