Skip to content

Commit 16d36da

Browse files
committed
fix(docs): quickstart and development instructions
* should build if you're just going to run elecrton . * should alter main.js if you're going to be developing.
1 parent 64bebce commit 16d36da

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ and [Node BACstack](https://github.com/fh1ch/node-bacstack).
1313
1414
![](images/overview.gif)
1515

16-
## Usage
16+
## Quickstart
1717

1818
Start Node BACstack Browser by using:
1919

@@ -22,13 +22,34 @@ git clone https://github.com/fh1ch/node-bacstack-browser.git
2222

2323
cd node-bacstack-browser
2424
npm i
25-
25+
npm run build
2626
npm start
2727
```
2828

2929
> **Note:** If the application window appears as a blank page, force refresh the
3030
> page using F5 (Windows) or CMD+R (OSX).
3131
32+
## Developing
33+
34+
in main.js switch the loadURL
35+
36+
```js
37+
win.loadURL('http://localhost:4200');
38+
39+
// win.loadURL(url.format({
40+
// pathname: path.join(__dirname, 'dist' , 'index.html'),
41+
// protocol: 'file:',
42+
// slashes: true
43+
// }));
44+
```
45+
46+
then start without building
47+
48+
```
49+
npm i
50+
npm start
51+
```
52+
3253
## Contributing
3354

3455
Any help is appreciated, from creating issues, to contributing documentation,

0 commit comments

Comments
 (0)