@devisfuture/electron-modular 1.1.2 → 1.1.4

package/README.md

@@ -66,6 +66,13 @@ TypeScript setup:
 
 > Tip: This package is published as ESM. When importing local modules, use `.js` extensions in runtime imports, e.g. `import { UserModule } from "./user/module.js"`.
 
+## Folders (build outputs)
+
+The `folders` option in `initSettings` tells the framework where your build artifacts live:
+
+- `distRenderer` — the build output folder for your renderer (web) bundle (e.g. Vite/webpack output).
+- `distMain` — the build output folder for your main process bundle (compiled ESM files).
+
 ---
 
 ## Quick Start
@@ -102,6 +109,10 @@ app.on("ready", async () => {
 
 ---
 
+## Example App
+
+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.
+
 ## Module Structure
 
 An example of each module's structure, but you can use your own:
@@ -175,7 +186,7 @@ export class UserService {
 
 ### Approach 2: Provider Pattern (Advanced)
 
-Use `provide` and `useFactory` to expose only necessary interface.
+Use `provide` and `useFactory` to expose only necessary types.
 
 #### tokens.ts
 
@@ -662,8 +673,6 @@ my-feature/
 
 ### 1. Use Providers for Cross-Module Communication
 
-✅ **Good:**
-
 ```typescript
 {
   provide: AUTH_PROVIDER,
@@ -675,19 +684,10 @@ my-feature/
 }
 ```
 
-❌ **Bad:**
-
-```typescript
-// Don't export entire service
-exports: [AuthService];
-```
-
 ### 2. Keep Services Focused
 
 Each service should have a single responsibility.
 
-✅ **Good:**
-
 ```typescript
 @Injectable()
 export class ResourcesService {
@@ -702,8 +702,6 @@ export class CacheWindowsService {
 
 ### 3. Use Tokens for All Cross-Module Dependencies
 
-✅ **Good:**
-
 ```typescript
 export const RESOURCES_REST_API_PROVIDER = Symbol("RESOURCES_REST_API_PROVIDER");
 

package/package.json

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