From c9417d2ee783c6fd9c101610b716cd66e06bf217 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Czechowski?= Date: Sun, 2 Sep 2018 17:55:56 +0200 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8f1bc7c..1e54cdf 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,28 @@ --- +## Rquirements + +- Node.js +- Angular CLI + +## NPM Scripts + +| command | description | +|------------------|-----------------------------------------------------------------| +| `npm run start` | start development server on `http://localhost:4200/` | +| `npm run build` | build production application and save to `./dist` | +| `npm run build:library` | build node module and save to `./dist/NlsGuilloche` | + ## Development server -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +Download dependencies with `npm i` or `yarn`. -## Code scaffolding - -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. +Run `npm run start` for a dev server. Browser opens and navigates automatically to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. ## Build -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. +Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. ## Author