diff --git a/README.md b/README.md index 0e5993e..c4ab0fd 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,6 @@ -# electron-quick-start +# electron-node-red -**Clone and run for a quick way to see an Electron in action.** - -This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/latest/tutorial/quick-start) within the Electron documentation. - -A basic Electron application needs just these files: - -- `index.html` - A web page to render. -- `main.js` - Starts the app and creates a browser window to render HTML. -- `package.json` - Points to the app's main file and lists its details and dependencies. - -You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/latest/tutorial/quick-start). +This is an Electron template to embed Node-RED with a UI generated by node-red-contrib-ui ## To Use @@ -18,9 +8,9 @@ To clone and run this repository you'll need [Git](https://git-scm.com) and [Nod ```bash # Clone this repository -git clone https://github.com/atom/electron-quick-start +git clone https://github.com/natcl/electron-node-red.git # Go into the repository -cd electron-quick-start +cd electron-node-red # Install dependencies and run the app npm install && npm start ```