From d6b5cd51905cd8596c967a94211ae11e491de935 Mon Sep 17 00:00:00 2001 From: Harold Boissenin <harold.boissenin@irstea.fr> Date: Fri, 13 Sep 2019 18:34:25 +0200 Subject: [PATCH] update README.md with more instructions and peer dependencies --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f91bd10..c9e9b16 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,29 @@ # @devatscience/ngx-debug - Source library to generate angular package ready for NPM ## How to -Once modification are done, +Once the changes are complete : +- Update the package.json file +- Increase version `"version": "0.1.1"` - 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"` - +- Name should be `"name": "@devatscience/ngx-debug"`, version `"version": "0.1.1"` +- Run `npm publish --access public` to send it on npmjs ## Library features - - Dump panel - Watcher - Spy - ApiRoute + +## Peer dependencies + "@devatscience/ngx-errors": "^0.1.0", + "@angular/common": "^8.2.0", + "@angular/core": "^8.2.0", + "@angular/forms": "^8.2.0", + "@angular/router": "^8.2.0", + "lodash": "^4.17.15", + "primeng": "^8.0.2", + "rxjs": "^6.5.2", + "rxjs-marbles": "^5.0.0", -- GitLab