@aggdirect/coolmap 3.0.3 → 5.0.1

package/README.md

@@ -1,57 +1,63 @@
 # Coolmap
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.0.
+This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
 
+## Code scaffolding
 
-## Installation
-
-To Install the library
+Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
 
-`Run npm install @aggdirect/coolmap`
+```bash
+ng generate component component-name
+```
 
-## Usage
+For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
 
-Providing the global configuration is optional and when used you should only provide the configuration in your root module.
+```bash
+ng generate --help
+```
 
-`import { CoolmapModule } from '@aggdirect/coolmap';`
+## Building
 
-Following we can use for coolmap.
+To build the library, run:
 
-    <app-nav (drawer)="boolean" (changeNav)="$event"></app-nav>
+```bash
+ng build coolmap
+```
 
-        <app-add-route-nav [navValue]="string"
-          (changeNav)="$event" 
-          (addemit)="$event" 
-          [updateRouteList]="boolean"></app-add-route-nav>
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
 
-          <app-map></app-map>
+### Publishing the Library
 
-          <app-job-code 
-           [jobdetail]="" 
-           (clearJobDetails)="$event"></app-job-code>
+Once the project is built, you can publish your library by following these steps:
 
-          <app-add-route 
-          (changeNav)="$event" 
-          [routeData]="boolean" 
-          (updateRouteList)="$event"></app-add-route>
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/coolmap
+   ```
 
-## Code scaffolding
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
 
-Run `ng generate component component-name --project coolmap` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project coolmap`.
-> Note: Don't forget to add `--project coolmap` or else it will be added to the default project in your `angular.json` file. 
+## Running unit tests
 
-## Build
+To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
 
-Run `ng build coolmap` to build the project. The build artifacts will be stored in the `dist/` directory.
+```bash
+ng test
+```
 
-## Publishing
+## Running end-to-end tests
 
-After building your library with `ng build coolmap`, go to the dist folder `cd dist/coolmap` and run `npm publish`.
+For end-to-end (e2e) testing, run:
 
-## Running unit tests
+```bash
+ng e2e
+```
 
-Run `ng test coolmap` to execute the unit tests via [Karma](https://karma-runner.github.io).
+Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
 
-## Further help
+## Additional Resources
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.