diff --git a/README.md b/README.md index 2a0348d..171c027 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,42 @@ -# Automated guilloche graph generator +
+ Random Guilloche Generator +
-![d3-guilloche](https://user-images.githubusercontent.com/10194510/40454963-20fbf46a-5eeb-11e8-863f-e8c619d8cda0.png) + +--- + +

Random Guilloche Generator

+ +
+ + version + +
+ +--- + +## 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 diff --git a/projects/nls-guilloche/package.json b/projects/nls-guilloche/package.json index 213548b..63515d5 100644 --- a/projects/nls-guilloche/package.json +++ b/projects/nls-guilloche/package.json @@ -1,6 +1,6 @@ { "name": "nls-guilloche", - "version": "1.0.0-rc.1", + "version": "1.0.0-rc.2", "repository": { "type": "git", "url": "https://github.com/nextlevelshit/nls-guilloche-generator"