Update documentation

edrlab · Mar 30, 2017 · 999a71d · 999a71d
1 parent 53e50dd
commit 999a71d
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,3 +5,37 @@ Desktop application for ebooks
 ## Status
 
 [![Build Status](https://travis-ci.org/edrlab/readium-desktop.svg?branch=master)](https://travis-ci.org/edrlab/readium-desktop)
+
+## Technologies
+
+* typescript
+* electron
+* reactjs
+* redux
+* i18next
+
+## Install
+
+Install all dependencies
+
+```
+npm install
+```
+
+## Getting started
+
+### Production
+
+```
+npm start
+```
+
+### Development
+
+```
+npm run start:dev
+```
+
+This environment provides a hot loader.
+So if you made changes in your code, electron will automatically reload
+your app.