From 16d36dade3d645268e8815ea532a70d3b47f78f2 Mon Sep 17 00:00:00 2001 From: Darrel O'Pry Date: Thu, 8 Mar 2018 13:47:34 -0500 Subject: [PATCH] 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. --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d773ff1..6263bd9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ and [Node BACstack](https://github.com/fh1ch/node-bacstack). ![](images/overview.gif) -## Usage +## Quickstart Start Node BACstack Browser by using: @@ -22,13 +22,34 @@ git clone https://github.com/fh1ch/node-bacstack-browser.git cd node-bacstack-browser npm i - +npm run build npm start ``` > **Note:** If the application window appears as a blank page, force refresh the > page using F5 (Windows) or CMD+R (OSX). +## Developing + +in main.js switch the loadURL + +```js + win.loadURL('http://localhost:4200'); + + // win.loadURL(url.format({ + // pathname: path.join(__dirname, 'dist' , 'index.html'), + // protocol: 'file:', + // slashes: true + // })); +``` + +then start without building + +``` +npm i +npm start +``` + ## Contributing Any help is appreciated, from creating issues, to contributing documentation,