From 5aa54b9fb2d22a018ce3dfdc10bfc62c974acf2f Mon Sep 17 00:00:00 2001
From: Benoit Alessandroni <benoit.alessandroni@gmail.com>
Date: Wed, 14 Nov 2018 13:50:38 +0100
Subject: [PATCH] Improving documentations

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 54 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 547520b1..0098afac 100644
--- a/README.md
+++ b/README.md
@@ -2,24 +2,76 @@
 
 HD app is the magic tool that allows the Happy Dev network to thrive in a decentralized way.
 
-## Requirements
+## Use cases
+
+Identified and scheduled use cases of the application includes (but are not limited to):
+
+- Listing of projects
+- Listing of members
+- Search of members by skills
+- Invoicing and billing
+- Project-scoped chat
+- Personal messaging
+
+### Chat
+
+The repository of the SIB Chat component can be found here:
+
+- https://git.happy-dev.fr/startinblox/sib-chat
+
+It is based on XMPP as messaging protocol, Prosody as the server and ConverseJS as the client.
+
+### Project
+
+The repository of the project listing components is the core and can be found here:
+
+- https://git.happy-dev.fr/startinblox/sib-core
+
+### Invoicing
+
+The invoicing component is still at an early stage. Its repository is here:
+
+- https://git.happy-dev.fr/startinblox/sib-invoicing 
+
+## Architecture
+
+Some general schema of the existing StartinBlox applications architecture can be found here:
+
+https://docs.google.com/presentation/d/1iCRGaJpFvZjhjIUnpsn6lRTJJ31ES6n94BNkJygzUwM/edit?usp=sharing
+
+## Installation
+
+If you want to contribute or test the app, please follow those steps.
+
+### Requirements
 
 You need to have both NodeJS and NPM installed and working
+A docker image will one day be provided including initialized server.
 
-## Install
+### Installation process
 
 clone then:
 
 * `make install`
 
+If you encounter any issues with the previous command, please try to execute :
+
+* `npm install`
+
+at the root directory of the project before attempting again the installation.
+
 ## Build
 
+A first build is mandatory for compiling the static assets.
+
 * `make build`
 
 or
 
 * `make watch`
 
+if you are working on something and want to benefit of the hot reload feature.
+
 ## Run server
 
 * `make serve`
-- 
GitLab