Commit d6b5cd51 authored by Harold Boissenin's avatar Harold Boissenin
Browse files

update README.md with more instructions and peer dependencies

No related merge requests found
Showing with 16 additions and 6 deletions
+16 -6
# @devatscience/ngx-debug # @devatscience/ngx-debug
Source library to generate angular package ready for NPM Source library to generate angular package ready for NPM
## How to ## 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) - 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` - Move to the generated library **dist** folder `cd .../dist/ngx-debug`
- Check the package.json file - Check the package.json file
- Name should be `"name": "@devatscience/ngx-debug"` - Name should be `"name": "@devatscience/ngx-debug"`, version `"version": "0.1.1"`
- Increase version `"version": "0.1.1"` - Run `npm publish --access public` to send it on npmjs
## Library features ## Library features
- Dump panel - Dump panel
- Watcher - Watcher
- Spy - Spy
- ApiRoute - 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",
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment