@aggdirect/coolmap-services 1.4.9 → 4.0.0

package/README.md

@@ -1,38 +1,63 @@
 # CoolmapServices
 
-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.
 
-## Installation
+## Code scaffolding
 
-To Install the library
+Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
 
-`Run npm install @aggdirect/coolmap-services`
+```bash
+ng generate component component-name
+```
 
-## Usage
+For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
 
-import { CoolmapService } from '@aggdirect/coolmap-services';
+```bash
+ng generate --help
+```
 
-`import { UtilsService } from '@aggdirect/coolmap-services';`
+## Building
 
-`Inject above imports to the component constructor.`
+To build the library, run:
 
-## Code scaffolding
+```bash
+ng build coolmap-services
+```
 
-Run `ng generate component component-name --project @aggdirect/coolmap-services` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project @aggdirect/coolmap-services`.
-> Note: Don't forget to add `--project @aggdirect/coolmap-services` or else it will be added to the default project in your `angular.json` file. 
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
 
-## Build
+### Publishing the Library
 
-Run `ng build @aggdirect/coolmap-services` to build the project. The build artifacts will be stored in the `dist/` directory.
+Once the project is built, you can publish your library by following these steps:
 
-## Publishing
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/coolmap-services
+   ```
 
-After building your library with `ng build @aggdirect/coolmap-services`, go to the dist folder `cd dist/@aggdirect/coolmap-services` and run `npm publish`.
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
 
 ## Running unit tests
 
-Run `ng test @aggdirect/coolmap-services` to execute the unit tests via [Karma](https://karma-runner.github.io).
+To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+
+```bash
+ng test
+```
+
+## Running end-to-end tests
+
+For end-to-end (e2e) testing, run:
+
+```bash
+ng e2e
+```
+
+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.