From 9a983c1a1a1e23638d1660f513070aab35a90e10 Mon Sep 17 00:00:00 2001
From: Maxime GRIS <m.gris@emotic.fr>
Date: Mon, 3 Apr 2017 10:20:56 +0200
Subject: [PATCH] update README

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fe58e80ed..57e1bc501 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,34 @@
 
 Bootstrap your project with Angular 4 and Electron (Typescript + SASS)
 
+Currently runs with:
+
+- Angular v4.0.1
+- Angular-CLI v1.0.0
+- Electron v1.6.2
+- Electron-Prebuilt v1.4.13
+
+## Getting Started
+
+Clone this repository locally :
+
+``` bash
+git clone https://github.com/maximegris/angular-electron.git
+```
+
+Install dependencies with your favorite dependency manager (npm or yarn) :
+
+``` bash
+npm install
+```
+
 ## To build for development
 
 **in a terminal window** -> npm start  
 **in another terminal window** -> npm run electron
 
-Note: also works with yarn
+The code for this is managed at `main.js`. In this sample, the app runs with a simple Electron window.
+By default, Developer tools is opened. You can unactivate it by uncomment `win.webContents.openDevTools();` in `main.js`.
 
 ## To build for production