Skip to content

Commit fed2ce5

Browse files
authored
Merge pull request #571 from bartduisters/patch-1
Update README.md
2 parents 7778d97 + bdb91e4 commit fed2ce5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Currently runs with:
1919
- Electron v11.0.3
2020
- Electron Builder v22.9.1
2121

22-
With this sample, you can :
22+
With this sample, you can:
2323

2424
- Run your app in a local development environment with Electron & Hot reload
2525
- Run your app in a production environment
@@ -31,13 +31,13 @@ With this sample, you can :
3131

3232
## Getting Started
3333

34-
Clone this repository locally :
34+
Clone this repository locally:
3535

3636
``` bash
3737
git clone https://github.com/maximegris/angular-electron.git
3838
```
3939

40-
Install dependencies with npm :
40+
Install dependencies with npm:
4141

4242
``` bash
4343
npm install
@@ -57,19 +57,19 @@ npm install -g @angular/cli
5757

5858
- **in a terminal window** -> npm start
5959

60-
Voila! You can use your Angular + Electron app in a local development environment with hot reload !
60+
Voila! You can use your Angular + Electron app in a local development environment with hot reload!
6161

6262
The application code is managed by `main.ts`. In this sample, the app runs with a simple Angular App (http://localhost:4200) and an Electron window.
6363
The Angular component contains an example of Electron and NodeJS native lib import.
6464
You can disable "Developer Tools" by commenting `win.webContents.openDevTools();` in `main.ts`.
6565

6666
## Use Electron / NodeJS / 3rd party libraries
6767

68-
As see in previous chapter, this sample project runs on both mode (web and electron). To make this happens, **you have to import your dependencies the right way**. Please check `providers/electron.service.ts` to watch how conditional import of libraries has to be done when using electron / NodeJS / 3rd party librairies in renderer context (ie. Angular).
68+
This sample project runs in both modes (web and electron). To make this work, **you have to import your dependencies the right way**. Please check `providers/electron.service.ts` to watch how conditional import of libraries has to be done when using electron / NodeJS / 3rd party libraries in renderer context (i.e. Angular).
6969

7070
## Browser mode
7171

72-
Maybe you only want to execute the application in the browser with hot reload ? Just run `npm run ng:serve:web`.
72+
Maybe you only want to execute the application in the browser with hot reload? Just run `npm run ng:serve:web`.
7373

7474
## Included Commands
7575

@@ -85,7 +85,7 @@ Maybe you only want to execute the application in the browser with hot reload ?
8585

8686
## You want to use a specific lib (like rxjs) in electron main thread ?
8787

88-
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 ?
88+
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?
8989

9090
## E2E Testing
9191

0 commit comments

Comments
 (0)