diff --git a/README.md b/README.md index 80f77c2e1e41de9e31164eb60db6168b364c0c0f..be8d3e184243d3f26b8cdba8bd72a325f43c2a3c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ # @devatscience/ngx-errors -Source library to generate angular package ready for NPM +Error handling for Angular. ## How to -Once the changes are complete : -- Update the package.json file -- Increase version `"version": "0.1.1"` -- Run `npm build ngx-errors` 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-errors` -- Check the package.json file -- Name should be `"name": "@devatscience/ngx-errors"`, version `"version": "0.1.1"` -- Run `npm publish --access public` to send it on npmjs +### Run the tests + +- Install the dependencies : `npm install` +- Run the test suite : `npm test` + +### Publish a new version + +- Use `npm version` to create a tagged commit for the new version. +- Push it. ## Library content