@meshmakers/shared-services 3.3.34 → 3.3.390

package/README.md

@@ -1,24 +1,51 @@
-# SharedServices
+# @meshmakers/shared-services
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.2.0.
+Angular library providing shared services for Octo Mesh Platform applications.
 
-## Code scaffolding
+Includes message service, navigation, breadcrumbs, command infrastructure, and utility services.
 
-Run `ng generate component component-name --project shared-services` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project shared-services`.
-> Note: Don't forget to add `--project shared-services` or else it will be added to the default project in your `angular.json` file. 
+Part of the [@meshmakers](https://www.npmjs.com/org/meshmakers) package ecosystem.
 
-## Build
+## Installation
+
+```bash
+npm install @meshmakers/shared-services
+```
+
+## Quick Start
+
+```typescript
+// app.config.ts
+import { provideMmSharedServices } from '@meshmakers/shared-services';
 
-Run `ng build shared-services` to build the project. The build artifacts will be stored in the `dist/` directory.
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideMmSharedServices(),
+  ]
+};
+```
 
-## Publishing
+## Available Services
+
+| Service | Description |
+|---------|-------------|
+| `MessageService` | User-facing messages (info, warning, error) |
+| `BreadCrumbService` | Navigation breadcrumb management |
+| `CommandService` | Command execution infrastructure |
+| `ProgressNotifierService` | Progress reporting and cancellation |
+
+## Build
 
-After building your library with `ng build shared-services`, go to the dist folder `cd dist/shared-services` and run `npm publish`.
+```bash
+npm run build:shared-services
+```
 
-## Running unit tests
+## Test
 
-Run `ng test shared-services` to execute the unit tests via [Karma](https://karma-runner.github.io).
+```bash
+npm test -- --project=@meshmakers/shared-services --watch=false
+```
 
-## Further help
+## Documentation
 
-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.
+See [Octo Mesh Platform documentation](https://docs.meshmakers.cloud).