Skip to content

Commit d860887

Browse files
update readme
1 parent 791fe61 commit d860887

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,18 +83,18 @@ Lets make an app called *MyCoolApp*.
8383

8484
That's it, you're done! Time for a beverage :coffee: :tea: :sake: :baby_bottle: :beer: :beers: :cocktail: :tropical_drink: :wine_glass:
8585

86-
:warning: the *"webplus.js"* file in the *"app"* folder contains the WebPlus engine code and you don't need to modify it.
86+
:warning: ***"app/webplus.js"*** contains the WebPlus engine code and you don't need to modify it.
8787

8888
# Under the Hood
8989

9090
When a WebPlus application launches, it..
9191

92-
1. Creates a [Windows Form](https://learn.microsoft.com/en-us/dotnet/desktop/winforms/?view=netframeworkdesktop-4.8) containing a [WebView2](https://learn.microsoft.com/en-us/microsoft-edge/webview2/) control.
93-
2. Loads persistent options from ***"app/app.json"***.
92+
1. Loads persistent options from ***"app/app.json"***.
93+
2. Creates a [Windows Form](https://learn.microsoft.com/en-us/dotnet/desktop/winforms/?view=netframeworkdesktop-4.8) containing a [WebView2](https://learn.microsoft.com/en-us/microsoft-edge/webview2/) control.
9494
3. Modifies the windows form according to the options.
9595
4. Loads ***"app/app.html"*** into the WebView2 control.
9696

97-
When ***"app/app.html"*** has fully loaded the `window.onload` event in *"app/app.js"* is fired, which starts the app running.
97+
When ***"app/app.html"*** has fully loaded the `window.onload` event in ***"app/app.js"*** is fired, which starts the app running.
9898

9999
So, for all intents and purposes WebPlus is a just a Windows Form encapsulating a WebView2 control that fills its client area, with a [host object coclass](https://learn.microsoft.com/en-us/microsoft-edge/webview2/how-to/hostobject?tabs=win32) glued on to provide some extra functionality, and hot reloading powered by a [FileSystemWatcher](https://learn.microsoft.com/en-us/dotnet/api/system.io.filesystemwatcher?vview=netframework-4.8.1).
100100

@@ -106,12 +106,13 @@ The default icon provided inside the ***"app"*** folder contains images with siz
106106

107107
## Options
108108

109-
WebPlus stores its persistent state in a the *"app/app.json"* file which has the following structure..
109+
WebPlus stores its persistent state in ***"app/app.json"*** which has the following structure..
110110

111111
```
112112
{
113113
HotReload: {Boolean},
114-
SaveOnExit {Boolean}, // Set to disable persistent state.
114+
SaveOnExit: {Boolean}, // Set to disable persistent state.
115+
UseDevTools: {Boolean}, // Not yet implemented.
115116
Title: {String} // Window title.
116117
X: {Number}, // Window position
117118
Y: {Number},

0 commit comments

Comments
 (0)