@dragonworks/ngx-dashboard-widgets 20.0.0 → 20.0.2

package/README.md

@@ -1,63 +1,58 @@
-# NgxDashboardWidgets
+# @dragonworks/ngx-dashboard-widgets
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.0.0.
+Widget collection for ngx-dashboard with Material Design 3 compliance.
 
-## Code scaffolding
-
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+## Installation
 
 ```bash
-ng generate component component-name
+npm install @dragonworks/ngx-dashboard-widgets @dragonworks/ngx-dashboard
 ```
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+## Included Widgets
 
-```bash
-ng generate --help
-```
+- **Arrow Widget** - Directional indicators with rotation
+- **Label Widget** - Text display with responsive sizing
+- **Clock Widget** - Analog/digital clock with real-time updates
+- **ResponsiveText Directive** - Canvas-optimized text sizing
 
-## Building
+## Usage
 
-To build the library, run:
+```typescript
+import { DashboardService } from '@dragonworks/ngx-dashboard';
+import { ArrowWidgetComponent } from '@dragonworks/ngx-dashboard-widgets';
 
-```bash
-ng build ngx-dashboard-widgets
+export class AppComponent {
+  constructor(dashboardService: DashboardService) {
+    // Register widgets
+    dashboardService.registerWidgetType(ArrowWidgetComponent);
+  }
+}
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
-
-### Publishing the Library
-
-Once the project is built, you can publish your library by following these steps:
-
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/ngx-dashboard-widgets
-   ```
-
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
-
-## Running unit tests
-
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
-
-```bash
-ng test
+## Creating Custom Widgets
+
+```typescript
+@Component({
+  selector: 'my-widget',
+  template: `<div>{{ state?.text }}</div>`,
+  standalone: true
+})
+export class MyWidgetComponent {
+  state = signal<any>({});
+  
+  static readonly metadata = {
+    widgetTypeId: 'my-widget',
+    displayName: 'My Widget',
+    iconName: 'star',
+    description: 'Custom widget example'
+  };
+}
 ```
 
-## Running end-to-end tests
-
-For end-to-end (e2e) testing, run:
-
-```bash
-ng e2e
-```
+## Documentation
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+See the [main repository](https://github.com/dragonworks/ngx-dashboard) for full documentation.
 
-## Additional Resources
+## License
 
-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.
+MIT

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@dragonworks/ngx-dashboard-widgets",
-  "version": "20.0.0",
+  "version": "20.0.2",
+  "description": "Widget collection for ngx-dashboard with Material Design 3 compliance including arrow, label, clock widgets and responsive text directive",
   "peerDependencies": {
     "@angular/common": "^20.0.0",
     "@angular/core": "^20.0.0",
@@ -10,6 +11,23 @@
     "tslib": "^2.3.0"
   },
   "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TobyBackstrom/ngx-dashboard.git"
+  },
+  "author": "Toby Backstrom",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/TobyBackstrom/ngx-dashboard/issues"
+  },
+  "homepage": "https://github.com/TobyBackstrom/ngx-dashboard#readme",
+  "keywords": [
+    "angular",
+    "dashboard",
+    "widgets",
+    "material-design",
+    "md3"
+  ],
   "module": "fesm2022/dragonworks-ngx-dashboard-widgets.mjs",
   "typings": "index.d.ts",
   "exports": {