@trimble-oss/moduswebcomponents-angular 1.8.0-ng18 → 1.8.0-ng20

package/README.md

@@ -1,73 +1,63 @@
-# Modus Angular Components: moduswebcomponents-angular
+# ModuswebcomponentsAngular
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.0.
+This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
 
-The components in this library were programmatically generated using the [StencilJS](https://stenciljs.com/) [Angular Framework Integration](https://stenciljs.com/docs/angular).
+## Code scaffolding
 
-## Installation
+Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
 
-- Install the Modus Angular Components Library and its Modus Web Component peer dependency
-  `npm install @trimble-oss/moduswebcomponents @trimble-oss/moduswebcomponents-angular`
+```bash
+ng generate component component-name
+```
 
-- You will need to import our styling in your main JavaScript or CSS file:
+For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
 
-  ```js
-  import "@trimble-oss/moduswebcomponents/modus-wc-styles.css";
-  ```
+```bash
+ng generate --help
+```
 
-- Add the following snippet to your `main.ts` (or any main module)
+## Building
 
-  ```typescript
-  import { defineCustomElements } from '@trimble-oss/moduswebcomponents/loader';
+To build the library, run:
 
-  defineCustomElements();
-  ```
+```bash
+ng build moduswebcomponents-angular
+```
 
-- Add the following snippet to your `app.module.ts` (or any app module)
+This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
 
-  ```typescript
-  import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
+### Publishing the Library
 
-  @NgModule({
-    ...
-    schemas: [CUSTOM_ELEMENTS_SCHEMA]
-  })
-  ```
+Once the project is built, you can publish your library by following these steps:
 
-## Example Usage
+1. Navigate to the `dist` directory:
+   ```bash
+   cd dist/moduswebcomponents-angular
+   ```
 
-- Use a modus button in your `app.component.html`
+2. Run the `npm publish` command to publish your library to the npm registry:
+   ```bash
+   npm publish
+   ```
 
-  ```html
-  <modus-wc-button color="primary" [disabled]="false">Modus Button</modus-wc-button>
-  ```
+## Running unit tests
 
-## Build
+To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
 
-To rebuild the Modus Angular Components you need to perform the following steps:
+```bash
+ng test
+```
 
-- From the `./integrations/angular/ng18` project directory run
-  `npm install` then `npm run build`
+## Running end-to-end tests
 
-### Referencing a local build of modus-wc
+For end-to-end (e2e) testing, run:
 
-#### Using npm link
+```bash
+ng e2e
+```
 
-- If you want to reference a local build of `modus-wc` you can run `npm link` from the `modus-wc-2.0` root
-directory and then `npm link @trimble-oss/moduswebcomponents` from the `ng18` directory.
+Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
 
-#### Using npm pack
+## Additional Resources
 
-- You can also run `npm pack` from the `modus-wc-2.0` root
-directory and then `npm install path/to/modus-wc-tarball.tgz` from `ng18` directory.
-
-## Debugging Locally
-
-To use the Modus Angular components locally for debugging and other purposes:
-
-- From `./ng18` project directory run `npm run build`
-- From `./ng18` project directory run `npm pack ./dist/trimble-oss/moduswebcomponents-angular`
-  - This will generate a tarball of the library: `trimble-cms-modus-wc-angular-0.0.1-ng18.tgz`
-
-You can now test the build locally with any Angular project by running `npm install path/to/trimble-cms-modus-wc-angular-0.0.1-ng18.tgz`
-and following the [installation steps](#installation).
+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.