docs: update README with Angular version compatibility details

README.md

@@ -12,12 +12,62 @@ This package allows you to use the [Tabler Icons](https://tabler.io/icons) in yo
 
 ## Install
 
-_1. Install the package_
+### 1. Install the package
 
 ```sh
-npm install angular-tabler-icons
-# or
-yarn add angular-tabler-icons
+npm i angular-tabler-icons
+```
+
+### Angular version compatibility
+
+| Angular | angular-tabler-icons       |
+| ------- | -------------------------- |
+| 19      | 3.22.0+                    |
+| 18      | _NOT OFFICIALLY SUPPORTED_ |
+| 17      | 2.40.1+                    |
+| 16      | 2.21.1+                    |
+| 15      | 1.117.1+                   |
+| 14      | 1.72.1+                    |
+| 13      | 1.53.1+                    |
+| 12      | 1.41.3+                    |
+| 11      | 1.41.0+                    |
+
+#### Angular 19 | >= v3.22
+
+With `[email protected]` we made some breaking changes.
+
+We are using the new signals API's like `input()`, `output()`, but also the new `linkedSignal()`, therefore this release is **NOT** backwards compatible
+
+**N.B.**
+
+_(We should have released a version 4.0.0)_
+
+#### Angular 18 | <= v3.10.0
+
+Angular 18 is _not officially supported_, however with `3.1.x` you can use the [overrides](https://docs.npmjs.com/cli/v10/configuring-npm/package-json?v=true#overrides) in your package.json when using `npm`
+
+```json
+"overrides": {
+  "angular-tabler-icons": {
+    "peerDependencies": {
+      "@angular/common": "18.x",
+      "@angular/core": "18.x"
+    }
+  }
+}
+```
+
+With `pnpm` you can use the [peerDependencyRules.allowVersions](https://pnpm.io/package_json#pnpmpeerdependencyrulesallowedversions) in your package.json
+
+```json
+"pnpm": {
+    "peerDependencyRules": {
+      "allowedVersions": {
+        "angular-tabler-icons>@angular/common": "18",
+        "angular-tabler-icons>@angular/core": "18"
+      }
+    }
+  },
 ```
 
 ## Usage
@@ -222,19 +272,6 @@ After importing the _IconsModule_ in your feature or shared module, use the icon
 <i-tabler name="brand-github" class="someclass"></i-tabler>
 ```
 
-## Angular version compatibility
-
-| Angular | angular-tabler-icons |
-| ------- | -------------------- |
-| 18 & 19 | 3.22.0+              |
-| 17      | 2.40.1+              |
-| 16      | 2.21.1+              |
-| 15      | 1.117.1+             |
-| 14      | 1.72.1+              |
-| 13      | 1.53.1+              |
-| 12      | 1.41.3+              |
-| 11      | 1.41.0+              |
-
 ## Contributing
 
 Feel free to report issues or to contribute to this project!

projects/angular-tabler-icons/package.json

@@ -23,8 +23,8 @@
   },
   "homepage": "https://github.com/pierreavn/angular-tabler-icons",
   "peerDependencies": {
-    "@angular/common": "17 - 19",
-    "@angular/core": "17 - 19"
+    "@angular/common": "^19",
+    "@angular/core": "^19"
   },
   "dependencies": {
     "tslib": "^2.8.1"