From 60cb65a0adfd6b4a0b00e6116729b513419ee5c8 Mon Sep 17 00:00:00 2001
From: Harold Boissenin <harold.boissenin@irstea.fr>
Date: Fri, 13 Sep 2019 14:00:41 +0200
Subject: [PATCH] update README.md how to

---
 README.md | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 6e94a68..f91bd10 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,19 @@
-# Debugger
+# @devatscience/ngx-debug
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.2.0.
+Source library to generate angular package ready for NPM
 
-## Install
+## How to
+Once modification are done,
+- Run `npm build ngx-debug` to generate a **dist** folder that will contain all the required NPM files (typeScript & compiled es5 js)
+- Move to the generated library **dist** folder `cd .../dist/ngx-debug`
+- Check the package.json file
+- Name should be `"name": "@devatscience/ngx-debug"`
+- Increase version `"version": "0.1.1"`
 
-Run `npm i @devatscience/ngx-debug` to install the library.
 
-## Content
+## Library features
 
-Dump panel, Watcher, Spy, ApiRoute
+- Dump panel
+- Watcher
+- Spy
+- ApiRoute
-- 
GitLab