@wamlib/ngx-screen-size-reporter 1.0.0 → 1.0.2

package/README.md

@@ -1,63 +1,38 @@
-# NgxScreenSizeReporter
-
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.1.0.
-
-## Code scaffolding
-
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
-
-```bash
-ng generate component component-name
 ```
-
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
-
-```bash
-ng generate --help
+npm install @wamlib/ngx-screen-size-reporter
 ```
 
-## Building
-
-To build the library, run:
-
-```bash
-ng build ngx-screen-size-reporter
+## Initialization
+```ts name="src/app/app.config.ts" {3}
+export const appConfig: ApplicationConfig = {
+ providers: [
+   provideScreenSizeReporter()
+ ]
+};
 ```
 
-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-screen-size-reporter
-   ```
-
-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
+## Initialization (With optional custom breakpoints)
+```ts name="src/app/app.config.ts" {3}
+export const appConfig: ApplicationConfig = {
+ providers: [
+   provideScreenSizeReporter({ small: '(max-width: 600px)' })
+ ]
+};
 ```
 
-## Running end-to-end tests
+## Usage
+```ts
+import { ScreenSizeReporter } from '@wamlib/ngx-screen-size-reporter';
 
-For end-to-end (e2e) testing, run:
-
-```bash
-ng e2e
+@Component({...})
+export class AppComponent {
+  protected screenSizeReporter = inject(ScreenSizeReporter);
+}
+```
+```html
+@if (screenSizeReporter.isSmallScreen()) {
+<app-mobile-nav />
+} @else {
+<app-desktop-sidebar />
+}
 ```
-
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
-
-## Additional Resources
-
-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.

package/package.json

@@ -1,6 +1,16 @@
 {
   "name": "@wamlib/ngx-screen-size-reporter",
-  "version": "1.0.0",
+  "version": "1.0.2",
+  "description": "A lightweight library for reporting and reacting to screen size changes in Angular apps.",
+  "keywords": [
+    "angular",
+    "breakpoints",
+    "signals"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://tangled.org/tmyams.bsky.social/ngx-screen-size-reporter"
+  },
   "peerDependencies": {
     "@angular/common": ">=15.0.0",
     "@angular/core": ">=15.0.0",