diff --git a/README.md b/README.md index 6e94a68c74e087b442fffe2ca585b5e8ca8b975b..f91bd100d3bc077d2fcd16ace24f8b5c459efaab 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