diff --git a/README.md b/README.md index 72131fa4e..f15603d5a 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ With this sample, you can : - Run your app in a production environment - Package your app into an executable file for Linux, Windows & Mac -/!\ Angular 8.x CLI needs Node 10.9 or later to work. +/!\ Angular 8.x CLI needs Node 10.9 or later to works correctly. ## Getting Started @@ -40,7 +40,7 @@ Install dependencies with npm : npm install ``` -There is an issue with `yarn` and `node_modules` that are only used in electron on the backend when the application is built by the packager. Please use `npm` as dependencies manager. +There is an issue with `yarn` and `node_modules` when the application is built by the packager. Please use `npm` as dependencies manager. If you want to generate Angular components with Angular-cli , you **MUST** install `@angular/cli` in npm global context. @@ -76,11 +76,11 @@ You can disable "Developer Tools" by commenting `win.webContents.openDevTools(); ## You want to use a specific lib (like rxjs) in electron main thread ? -You can do this! Just by importing your library in npm dependencies (not devDependencies) with `npm install --save`. It will be loaded by electron during build phase and added to the final package. Then use your library by importing it in `main.ts` file. Easy no ? +YES! You can do it! Just by importing your library in npm dependencies section (not **devDependencies**) with `npm install --save`. It will be loaded by electron during build phase and added to your final package. Then use your library by importing it in `main.ts` file. Quite simple, isn't it ? ## Browser mode -Maybe you want to execute the application in the browser with hot reload ? You can do it with `npm run ng:serve:web`. +Maybe you want to execute the application in the browser with hot reload ? Just run `npm run ng:serve:web`. **Note that you can't use Electron or NodeJS native libraries in this case.** Please check `providers/electron.service.ts` to watch how conditional import of electron/Native libraries is done. ## Branch & Packages version